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 4.2KB

6 years ago
7 years ago
7 years ago
7 years ago
7 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
  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. A fast static site generator in a single binary with everything built-in.
  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. ## Comparisons with other static site generators
  8. | | Gutenberg | Cobalt | Hugo | Pelican |
  9. |--------------------------|-----------|--------|------|---------|
  10. | Single binary | ✔ | ✔ | ✔ | ✕ |
  11. | Language | Rust | Rust | Go | Python |
  12. | Syntax highlighting | ✔ | ✔ | ✔ | ✔ |
  13. | Sass compilation | ✔ | ✕ | ✕ | ✔ |
  14. | Assets co-location | ✔ | ✔ | ✔ | ✔ |
  15. | i18n | ✕ | ✕ | ✔ | ✔ |
  16. | Image processing | ✕ | ✕ | ✔ | ✔ |
  17. | Search | ✕ | ✕ | ✕ | ✔ |
  18. | Sane template engine | ✔ | ✔ | ✕✕✕ | ✔ |
  19. | Themes | ✔ | ✕ | ✔ | ✔ |
  20. | Shortcodes | ✔ | ✕ | ✔ | ✔ |
  21. | Internal links | ✔ | ✕ | ✔ | ✔ |
  22. | Table of contents | ✔ | ✕ | ✔ | ✔ |
  23. | Automatic header anchors | ✔ | ✕ | ✔ | ✔ |
  24. | Aliases | ✔ | ✕ | ✔ | ✔ |
  25. | Pagination | ✔ | ✕ | ✔ | ✔ |
  26. | Custom taxonomies | ✕ | ✕ | ✔ | ✕ |
  27. | Data files | ✕ | ✔ | ✔ | ✕ |
  28. Supported content formats:
  29. - Gutenberg: markdown
  30. - Cobalt: markdown
  31. - Hugo: markdown, asciidoc, org-mode
  32. - Pelican: reStructuredText, markdown, asciidoc, org-mode, whatever-you-want
  33. Note that many features of Pelican are coming from plugins, which might be tricky
  34. to use because of version mismatch or lacking documentation.
  35. ## Contributing
  36. As the documentation site is automatically built on commits to master, all development
  37. should happen on the `next` branch, unless it is fixing the current documentation.
  38. If you want a feature added or modified, please open an issue to discuss it before doing a PR.
  39. ### Adding syntax highlighting languages and themes
  40. #### Adding a syntax
  41. Syntax highlighting depends on submodules so ensure you load them first:
  42. ```bash
  43. $ git submodule update --init
  44. ```
  45. Gutenberg only works with syntaxes in the `.sublime-syntax` format. If your syntax
  46. is in `.tmLanguage` format, open it in Sublime Text and convert it to `sublime-syntax` by clicking on
  47. Tools > Developer > New Syntax from ... and put it at the root of `sublime_syntaxes`.
  48. You can also add a submodule to the repository of the wanted syntax:
  49. ```bash
  50. $ cd sublime_syntaxes
  51. $ git submodule add https://github.com/elm-community/SublimeElmLanguageSupport
  52. ```
  53. Note that you can also only copy manually the updated syntax definition file but this means
  54. Gutenberg won't be able to automatically update it.
  55. You can check for any updates to the current packages by running:
  56. ```bash
  57. $ git submodule update --remote --merge
  58. ```
  59. And finally from the root of the components/rendering crate run the following command:
  60. ```bash
  61. $ cargo run --example generate_sublime synpack ../../sublime_syntaxes ../../sublime_syntaxes/newlines.packdump ../../sublime_syntaxes/nonewlines.packdump
  62. ```
  63. #### Adding a theme
  64. A gallery containing lots of themes is located at https://tmtheme-editor.herokuapp.com/#!/editor/theme/Agola%20Dark.
  65. More themes can be easily added to gutenberg, just make a PR with the wanted theme added in the `sublime_themes` directory
  66. and run the following command from the root of the components/rendering:
  67. ```bash
  68. $ cargo run --example generate_sublime themepack ../../sublime_themes ../../sublime_themes/all.themedump
  69. ```
  70. You should see the list of themes being added.