All contributions are welcome! To contribute to this project, create a branch off of
main
. Once your work is complete, submit a pull request. The project maintainers will
look over your changes. Once your changes have been approved, they will be merged and
deployed to the production site.
Before contributing, make sure to read our README.md as well as the
style guideline,
we also recommend testing your changes before submitting a edit (pull request). If you are using the web-based editor
(via the edit
link found in each entry page), you can following
the instructions here
for how to create a pull request.
After creating a pull request, an administrator will review your proposed change and merge it into the site if everything looks good, or leave a feedback if further changes are required.
If you have questions, feel free to reach out to us here.
data/
: Site content, texts, translations, images, etc.etc/
: Miscellaneous files.src/
: Source code.
npm run build
: Generates the entire site, saves output todist/
.npm run build:dev
: Same asnpm run build
, all links are generated with.html
extension.npm run clean
: Cleans up projects.npm run compile
: Compiles source code.npm run dev
: Generates the entire site and starts a server (same result asnpm run build:dev
+npm run start
).npm run dev:book
: Generatestmdict.com/book/
and starts a server.npm run dev:chaldea
: Generateschaldea.tmdict.com
and starts a server.npm run dev:tmdict
: Generatestmdict.com
and starts a server.npm run start
: Starts a server to view the generated site indist/
, accessible athttp://localhost:8080/
in a browser.