@@ -0,0 +1,23 @@ | |||||
--- | |||||
name: Bug Report | |||||
about: Did you run into an issue with the zola command line? | |||||
--- | |||||
# Bug Report | |||||
## Environment | |||||
Zola version: | |||||
## Expected Behavior | |||||
Tell us what should have happened. | |||||
## Current Behavior | |||||
Tell us what happens instead of the expected behavior. If you are seeing an | |||||
error, please include the full error message and stack trace. You can get the | |||||
stacktrace of a panic by adding `RUST_BACKTRACE=1` when running a `zola` command. | |||||
## Step to reproduce | |||||
Please provide the steps to reproduce the issue. | |||||
If the issue is hard to reproduce, please provide a sample repository or sample | |||||
that triggers the bug. |
@@ -0,0 +1,14 @@ | |||||
--- | |||||
name: Documentation | |||||
about: Is the documentation lacking or has typos/errors/missing/outdated content? | |||||
--- | |||||
# Documentation issue | |||||
## Summary | |||||
What is the issue? Is the documentation unclear? Is it missing information? | |||||
## Proposed solution | |||||
A quick explanation of what you would like to see to solve the issue. | |||||
If you want to add content, please explain what you were looking fod and what was | |||||
your process while looking at the current documentation. |
@@ -0,0 +1,20 @@ | |||||
**IMPORTANT: Please do not create a Pull Request adding a new feature without discussing it first.** | |||||
The place to discuss new features is the forum: <https://zola.discourse.group/> | |||||
If you want to add a new feature, please open a thread there first in the feature requests section. | |||||
Sanity check: | |||||
* [ ] Have you checked to ensure there aren't other open [Pull Requests](../../pulls) for the same update/change? | |||||
## Code changes | |||||
(Delete or ignore this section for documentation changes) | |||||
* [ ] Are you doing the PR on the `next` branch? | |||||
If the change is a new feature or adding to/changing an existing one: | |||||
* [ ] Have you created/updated the relevant documentation page(s)? | |||||
@@ -0,0 +1,66 @@ | |||||
# Contributing | |||||
**As the documentation site is automatically built on commits to master, all development happens on | |||||
the `next` branch, unless it is fixing the current documentation.** | |||||
However, if you notice an error or typo in the documentation, feel free to directly submit a PR without opening an issue. | |||||
## Feature requests | |||||
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. | |||||
Requested features will not be all added: an ever-increasing features set makes for a hard to use and explain softwares. | |||||
Having something simple and easy to use for 90% of the usecases is more interesting than covering 100% usecases after sacrificing simplicity. | |||||
## Issues tagging | |||||
As the development happens on the `next` branch, issues are kept open until a release containing the fix is out. | |||||
During that time, issues already resolved will have a `done` tag. | |||||
If you want to work on an issue, please mention it in a comment to avoid potential duplication of work. If you have | |||||
any questions on how to approach it do not hesitate to ping me (@keats). | |||||
Easy issues are tagged with `help wanted` and/or `good first issue` | |||||
## Adding syntax highlighting languages and themes | |||||
### Adding a syntax | |||||
Syntax highlighting depends on submodules so ensure you load them first: | |||||
```bash | |||||
$ git submodule update --init | |||||
``` | |||||
Zola 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: | |||||
```bash | |||||
$ 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 | |||||
Zola won't be able to automatically update it. | |||||
You can check for any updates to the current packages by running: | |||||
```bash | |||||
$ git submodule update --remote --merge | |||||
``` | |||||
And finally from the root of the components/config crate run the following command: | |||||
```bash | |||||
$ cargo run --example generate_sublime synpack ../../sublime_syntaxes ../../sublime_syntaxes/newlines.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 Zola, 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/config: | |||||
```bash | |||||
$ cargo run --example generate_sublime themepack ../../sublime_themes ../../sublime_themes/all.themedump | |||||
``` | |||||
You should see the list of themes being added. |
@@ -53,55 +53,3 @@ Hugo gets `~`. It is probably the most powerful template engine in the list afte | |||||
Many features of Pelican are coming from plugins, which might be tricky | Many features of Pelican are coming from plugins, which might be tricky | ||||
to use because of version mismatch or lacking documentation. Netlify supports Python | to use because of version mismatch or lacking documentation. Netlify supports Python | ||||
and Pipenv but you still need to install your dependencies manually. | and Pipenv but you still need to install your dependencies manually. | ||||
## 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: | |||||
```bash | |||||
$ git submodule update --init | |||||
``` | |||||
Zola 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: | |||||
```bash | |||||
$ 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 | |||||
Zola won't be able to automatically update it. | |||||
You can check for any updates to the current packages by running: | |||||
```bash | |||||
$ git submodule update --remote --merge | |||||
``` | |||||
And finally from the root of the components/config crate run the following command: | |||||
```bash | |||||
$ cargo run --example generate_sublime synpack ../../sublime_syntaxes ../../sublime_syntaxes/newlines.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 Zola, 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/config: | |||||
```bash | |||||
$ cargo run --example generate_sublime themepack ../../sublime_themes ../../sublime_themes/all.themedump | |||||
``` | |||||
You should see the list of themes being added. |