Skip to content

Latest commit

 

History

History
36 lines (28 loc) · 1.95 KB

CONTRIBUTING.md

File metadata and controls

36 lines (28 loc) · 1.95 KB
Raw

Contributing

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.

Navigation

  • data/: Site content, texts, translations, images, etc.
  • etc/: Miscellaneous files.
  • src/: Source code.

Useful Commands

  • npm run build: Generates the entire site, saves output to dist/.
  • npm run build:dev: Same as npm 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 as npm run build:dev + npm run start).
  • npm run dev:book: Generates tmdict.com/book/ and starts a server.
  • npm run dev:chaldea: Generates chaldea.tmdict.com and starts a server.
  • npm run dev:tmdict: Generates tmdict.com and starts a server.
  • npm run start: Starts a server to view the generated site in dist/, accessible at http://localhost:8080/ in a browser.