Firefox-UI-Fix/docs
alstjr7375 017bc24aa6 Doc: CREDITS - Update #762 #765 2023-08-30 15:50:59 +09:00
..
Omni_ja.md Doc: Improve document readability 2022-11-17 16:03:59 +05:00
Preference.md Doc: Preference - Update autoconfig contents 2023-02-03 17:35:54 +09:00
Project_Structure.md Fix: Icons - Replace to acorn icons #213 2023-04-24 10:42:31 +09:00
README.md Doc: CREDITS - Update #762 #765 2023-08-30 15:50:59 +09:00
Restrictions.md Docs: Restrictions #744 2023-08-14 23:59:16 +09:00
Rules.md Doc: Developer - Update to the latest information 2022-12-20 05:05:42 +09:00
Smart_Bookmarks.md Doc: Smart Bookmarks - Missing periods at end of the sentences #682 2023-04-17 14:36:34 +09:00

README.md

Developer Documents for Firefox Custom

Table of Contents

Basics

The following documents may be helpful:

Firefox Source Code:

Firefox Documents:

Test for non-Mac users:

If you have difficulty contributing, please feel free to click this link to explain.
I will help you as much as I know.

Project-Specific

Environment

git and yarn must 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__ directory, 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

Rules

This is a rough guideline. (Not forced)

Advanced Customizing

Smart Bookmarks

Policies

Preference

User Custom CSS

Basics

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

Unlike User config, they are located in <FIREFOX_PROFILE>/chrome/.

Start Guide:

CSS, SASS Documents:

Live Debugging:

Advanced CSS keywords:

Restrictions