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.

README.md 3.0KB

7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. # Gutenberg
  2. [![Build Status](https://travis-ci.org/Keats/gutenberg.svg?branch=master)](https://travis-ci.org/Keats/gutenberg)
  3. [![Build status](https://ci.appveyor.com/api/projects/status/h4t9r6h5gom839q0/branch/master?svg=true)](https://ci.appveyor.com/project/Keats/gutenberg/branch/master)
  4. An opinionated static site generator written in Rust.
  5. Documentation is available on [its site](https://www.getgutenberg.io/documentation/getting-started/installation/) or
  6. in the `docs/content` folder of the repository.
  7. ## Example sites
  8. - [vincent.is](https://vincent.is): https://gitlab.com/Keats/vincent.is
  9. - [code<future](http://www.codelessfuture.com/)
  10. - http://t-rex.tileserver.ch (https://github.com/pka/t-rex-website/)
  11. - [adrien.is](https://adrien.is): https://github.com/Fandekasp/fandekasp.github.io
  12. - [Philipp Oppermann's blog](https://os.phil-opp.com/): https://github.com/phil-opp/blog_os/tree/master/blog
  13. - [seventeencups](https://www.seventeencups.net): https://github.com/17cupsofcoffee/seventeencups.net
  14. - [j1m.net](https://j1m.net): https://gitlab.com/jwcampbell/j1mnet
  15. ## Contributing
  16. As the documentation site is automatically built on commits to master, all development
  17. should happen on the `next` branch, unless it is fixing the current documentation.
  18. If you want a feature added or modified, please open an issue to discuss it before doing a PR.
  19. ### Adding syntax highlighting languages and themes
  20. #### Adding a syntax
  21. Syntax highlighting depends on submodules so ensure you load them first:
  22. ```bash
  23. $ git submodule update --init
  24. ```
  25. Gutenberg only works with syntaxes in the `.sublime-syntax` format. If your syntax
  26. is in `.tmLanguage` format, open it in Sublime Text and convert it to `sublime-syntax` by clicking on
  27. Tools > Developer > New Syntax from ... and put it at the root of `sublime_syntaxes`.
  28. You can also add a submodule to the repository of the wanted syntax:
  29. ```bash
  30. $ cd sublime_syntaxes
  31. $ git submodule add https://github.com/elm-community/Elm.tmLanguage.git
  32. ```
  33. Note that you can also only copy manually the updated syntax definition file but this means
  34. Gutenberg won't be able to automatically update it.
  35. You can check for any updates to the current packages by running:
  36. ```bash
  37. $ git submodule update --remote --merge
  38. ```
  39. And finally from the root of the components/rendering crate run the following command:
  40. ```bash
  41. $ cargo run --example generate_sublime synpack ../../sublime_syntaxes ../../sublime_syntaxes/newlines.packdump ../../sublime_syntaxes/nonewlines.packdump
  42. ```
  43. #### Adding a theme
  44. A gallery containing lots of themes is located at https://tmtheme-editor.herokuapp.com/#!/editor/theme/Agola%20Dark.
  45. More themes can be easily added to gutenberg, just make a PR with the wanted theme added in the `sublime_themes` directory
  46. and run the following command from the root of the components/rendering:
  47. ```bash
  48. $ cargo run --example generate_sublime themepack ../../sublime_themes ../../sublime_themes/all.themedump
  49. ```
  50. You should see the list of themes being added.