Firefox-UI-Fix/docs/README.md

Develper Documents

Table of Contents

• Basics
• Project-Specific
  • Environment
  • Project Structure
  • Rules
• User Custom CSS
  • Basics
  • Restrictions

Basics

The following documents may be helpful:

• Roadmap
• Each Versions Plan
• Wiki:Compatibility Issues Solution
• Wiki:Tips

Firefox Source Code:

• Github
• Searchfox
• Firefox Source Docs

Firefox Documents:

• Support Mozilla: Firefox advanced customization and configuration options
• Support Mozilla: Profiles - Where Firefox stores your bookmarks, passwords and other user data

Test for None mac users:

• Docker-OSX

Project-Specific

Environment

git and yarn should be installed.

You can configure it as follows:

## clone repository
git clone https://github.com/black7375/Firefox-UI-Fix.git
cd ./Firefox-UI-Fix

## checkout branch
git checkout <BRANCH_NAME>

## env setup
yarn install

You can build with this command:

yarn build

You can check test and css validate:

## test - When you make mixin or function
# __tests__ direcory, You can also find out how to use internal utils.
yarn test

## validate - Will be failed, this project uses non-standard features.
# Just use only for checking.
yarn validate

Project Structure

• Project_Structure.md.

Rules

This is a rough guideline. (Not forced)

• Rules.md.

User Custom CSS

Basics

userChrome.css file is for browser UI, userContent.css file is for web contents.

Start Guide:

• What is userChrome.css? What can it do?
• How to Create a userChrome.css File
• Where to Find Style Recipes

CSS, SASS Documents:

• MDN: CSS
• MDN: Introducing the CSS Cascade
• SASS(SCSS)
• SASS Live Compile

Live Debugging:

• Tutorial: How to create and live-debug userChrome.css
• Browser Toolbox
• Style Editor

Advanced CSS keywords:

• UDN: Chrome-only CSS reference
• UDN: Mozilla CSS extensions

Restrictions

• Restrictions.md.