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.
Vincent Prouillet ab5a3c58db
Merge pull request #163 from RadicalZephyr/remove-dependency-cycle
7 years ago
ci Improve sorting speed 7 years ago
completions Update completions 7 years ago
components Extract syntex highlighting module into a new component in workspace 7 years ago
docs Properly parse shortcode arg value types 7 years ago
src Allow static folder to be missing 7 years ago
sublime_syntaxes Add Nim syntax 7 years ago
sublime_themes Add 1337 color scheme 7 years ago
.editorconfig Create new project 8 years ago
.gitignore WIP site 7 years ago
.gitmodules Add GenericConfig and VimL syntaxes 7 years ago
.travis.yml Try to make windows work + remove musl 7 years ago
CHANGELOG.md Properly parse shortcode arg value types 7 years ago
Cargo.lock Extract syntex highlighting module into a new component in workspace 7 years ago
Cargo.toml Extract syntex highlighting module into a new component in workspace 7 years ago
LICENSE Forgot License 7 years ago
README.md Fix minor run-on sentence 7 years ago
appveyor.yml Sass works on windows; try to use msvc on appveyor 7 years ago
build.rs Disable build.rs now that completions files are built 7 years ago
netlify.toml Finishing up site (#131) 7 years ago

README.md

Gutenberg

Build Status Build status

An opinionated static site generator written in Rust.

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

Example sites

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/Elm.tmLanguage.git

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.