You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

CONTRIBUTING.md 2.7KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. # Contributing
  2. **As the documentation site is automatically built on commits to master, all development happens on
  3. the `next` branch, unless it is fixing the current documentation.**
  4. However, if you notice an error or typo in the documentation, feel free to directly submit a PR without opening an issue.
  5. ## Feature requests
  6. If you want a feature added or modified, please open a thread on the [forum](https://zola.discourse.group/) to discuss it before doing a PR.
  7. Requested features will not be all added: an ever-increasing features set makes for a hard to use and explain softwares.
  8. Having something simple and easy to use for 90% of the usecases is more interesting than covering 100% usecases after sacrificing simplicity.
  9. ## Issues tagging
  10. As the development happens on the `next` branch, issues are kept open until a release containing the fix is out.
  11. During that time, issues already resolved will have a `done` tag.
  12. If you want to work on an issue, please mention it in a comment to avoid potential duplication of work. If you have
  13. any questions on how to approach it do not hesitate to ping me (@keats).
  14. Easy issues are tagged with `help wanted` and/or `good first issue`
  15. ## Adding syntax highlighting languages and themes
  16. ### Adding a syntax
  17. Syntax highlighting depends on submodules so ensure you load them first:
  18. ```bash
  19. $ git submodule update --init
  20. ```
  21. Zola only works with syntaxes in the `.sublime-syntax` format. If your syntax
  22. is in `.tmLanguage` format, open it in Sublime Text and convert it to `sublime-syntax` by clicking on
  23. Tools > Developer > New Syntax from ... and put it at the root of `sublime_syntaxes`.
  24. You can also add a submodule to the repository of the wanted syntax:
  25. ```bash
  26. $ cd sublime_syntaxes
  27. $ git submodule add https://github.com/elm-community/SublimeElmLanguageSupport
  28. ```
  29. Note that you can also only copy manually the updated syntax definition file but this means
  30. Zola won't be able to automatically update it.
  31. You can check for any updates to the current packages by running:
  32. ```bash
  33. $ git submodule update --remote --merge
  34. ```
  35. And finally from the root of the components/config crate run the following command:
  36. ```bash
  37. $ cargo run --example generate_sublime synpack ../../sublime_syntaxes ../../sublime_syntaxes/newlines.packdump
  38. ```
  39. ### Adding a theme
  40. A gallery containing lots of themes is located at https://tmtheme-editor.herokuapp.com/#!/editor/theme/Agola%20Dark.
  41. More themes can be easily added to Zola, just make a PR with the wanted theme added in the `sublime_themes` directory
  42. and run the following command from the root of the components/config:
  43. ```bash
  44. $ cargo run --example generate_sublime themepack ../../sublime_themes ../../sublime_themes/all.themedump
  45. ```
  46. You should see the list of themes being added.