Thanks for considering to contribute!
To contribute to NotionNext, follow these steps:
- Fork the repository to your GitHub account.
- Clone the repository to your device (or use something like Codespaces).
- Create a new branch in the repository.
- Make your modifications.
- Commit your modifications and push the branch.
- Create a PR from the branch in your fork to NotionNext'
main
branch.
This project is built with Next.js and yarn
as the package manager.
Here are some commands that you can use:
yarn
: install dependenciesyarn dev
: compile and hot-reload for developmentyarn build
: compile and minify for productionyarn start
: serve the compiled build in production mode
If you want to submit your custom theme to NotionNext, copy a new folder in
themes
from example
. The folder name will be the
theme's key.
If your language is not yet supported by NotionNext, please contribute a localization! Follow these steps to add a new localization:
- Copy one of the en-US.js in lang-dir and rename the new
directory into your language's code ( e.g.
zh-CN.js
). - Start translating the strings.
- Add your language config to lang.js.
- Create a PR with your localization updates.