Go to file
2018-03-21 15:25:25 +01:00
ci Improve sorting speed 2017-07-04 18:33:58 +09:00
completions Fix config CLI option 2018-03-16 19:11:12 +01:00
components Fix some bugs in search 2018-03-20 23:08:20 +01:00
docs Design tweaks on docs 2018-03-21 15:25:25 +01:00
src Move copy utils to utils crate 2018-03-20 18:43:17 +01:00
sublime_syntaxes v0.3.2 2018-03-05 19:26:27 +01:00
sublime_themes Add a bunch of themes, light and dark. 2018-02-28 21:15:25 +00:00
test_site Preserve folder structure of SCSS content 2018-03-17 13:22:23 -06:00
.editorconfig Create new project 2016-12-06 14:51:33 +09:00
.gitignore Move copy utils to utils crate 2018-03-20 18:43:17 +01:00
.gitmodules Elm-syntax submodule moved 2018-01-29 19:10:18 +01:00
.travis.yml Try to remove sudo: required in travis 2018-01-25 12:44:41 +01:00
appveyor.yml Sass works on windows; try to use msvc on appveyor 2017-07-13 22:45:31 +09:00
build.rs Config with i18n 2018-01-15 17:54:06 +01:00
Cargo.lock Search is working now 2018-03-20 21:27:33 +01:00
Cargo.toml [WIP] Search 2018-03-20 18:43:30 +01:00
CHANGELOG.md Add indented Sass to changelog 2018-03-19 18:50:04 +01:00
EXAMPLES.md Add andrei.blue 2018-03-01 09:17:05 +01:00
LICENSE USe date range for license 2018-01-16 13:39:56 +01:00
netlify.toml Try to update netlify.toml 2018-02-22 19:03:00 +01:00
README.md Add support content formats to comparison 2018-03-12 18:09:28 +01:00

Gutenberg

Build Status Build status

A fast static site generator in a single binary with everything built-in.

Documentation is available on its site or in the docs/content folder of the repository.

Comparisons with other static site generators

Gutenberg Cobalt Hugo Pelican
Single binary
Language Rust Rust Go Python
Syntax highlighting
Sass compilation
Assets co-location
i18n
Image processing
Search
Sane template engine ✕✕✕
Themes
Shortcodes
Internal links
Table of contents
Automatic header anchors
Aliases
Pagination
Custom taxonomies
Data files

Supported content formats:

  • Gutenberg: markdown
  • Cobalt: markdown
  • Hugo: markdown, asciidoc, org-mode
  • Pelican: reStructuredText, markdown, asciidoc, org-mode, whatever-you-want

Contributing

As the documentation site is automatically built on commits to master, all development should happen on the next branch, unless it is fixing the current documentation.

If you want a feature added or modified, please open an issue to discuss it before doing a PR.

Adding syntax highlighting languages and themes

Adding a syntax

Syntax highlighting depends on submodules so ensure you load them first:

$ git submodule update --init 

Gutenberg only works with syntaxes in the .sublime-syntax format. If your syntax is in .tmLanguage format, open it in Sublime Text and convert it to sublime-syntax by clicking on Tools > Developer > New Syntax from ... and put it at the root of sublime_syntaxes.

You can also add a submodule to the repository of the wanted syntax:

$ cd sublime_syntaxes
$ git submodule add https://github.com/elm-community/SublimeElmLanguageSupport

Note that you can also only copy manually the updated syntax definition file but this means Gutenberg won't be able to automatically update it.

You can check for any updates to the current packages by running:

$ git submodule update --remote --merge

And finally from the root of the components/rendering crate run the following command:

$ cargo run --example generate_sublime synpack ../../sublime_syntaxes ../../sublime_syntaxes/newlines.packdump ../../sublime_syntaxes/nonewlines.packdump

Adding a theme

A gallery containing lots of themes is located at https://tmtheme-editor.herokuapp.com/#!/editor/theme/Agola%20Dark. More themes can be easily added to gutenberg, just make a PR with the wanted theme added in the sublime_themes directory and run the following command from the root of the components/rendering:

$ cargo run --example generate_sublime themepack ../../sublime_themes ../../sublime_themes/all.themedump

You should see the list of themes being added.