Skip to content

Commit 58b54ef

Browse files
committed
Update docs
1 parent a302ec9 commit 58b54ef

File tree

99 files changed

+80
-352
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

99 files changed

+80
-352
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,6 @@ If you want to work on an issue, please mention it in a comment to avoid potenti
1919
any questions on how to approach it do not hesitate to ping me (@keats).
2020
Easy issues are tagged with `help wanted` and/or `good first issue`
2121

22-
## Adding syntax highlighting languages and themes
22+
## Adding syntax highlighting languages, themes or aliases
2323

2424
Open an issue on the [Giallo repository](https://github.com/getzola/giallo).

components/config/src/config/markup.rs

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,6 @@ impl Highlighting {
5454
registry.add_theme_from_path(config_dir.join(theme))?;
5555
}
5656

57-
registry.add_plain_grammar(&["txt"])?;
5857
registry.link_grammars();
5958

6059
match &self.theme {
@@ -83,7 +82,7 @@ impl Highlighting {
8382
self.style == HighlightStyle::Class
8483
}
8584

86-
pub fn generate_themes_css(&self) -> Vec<(String, String)> {
85+
pub fn generate_themes_css(&self) -> Vec<(&'static str, String)> {
8786
let mut out = Vec::new();
8887

8988
if self.style == HighlightStyle::Inline {
@@ -94,17 +93,17 @@ impl Highlighting {
9493
match &self.theme {
9594
HighlightConfig::Single { theme } => {
9695
out.push((
97-
theme.clone(),
96+
"giallo.css",
9897
self.registry.generate_css(theme, "z-").expect("theme to be present"),
9998
));
10099
}
101100
HighlightConfig::Dual { light_theme, dark_theme } => {
102101
out.push((
103-
light_theme.clone(),
102+
"giallo-light.css",
104103
self.registry.generate_css(light_theme, "z-").expect("theme to be present"),
105104
));
106105
out.push((
107-
dark_theme.clone(),
106+
"giallo-dark.css",
108107
self.registry.generate_css(dark_theme, "z-").expect("theme to be present"),
109108
));
110109
}

docs/config.toml

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,7 @@ index_format = "elasticlunr_json"
1616
external_links_class = "external"
1717

1818
[markdown.highlighting]
19-
theme = "github-dark"
20-
21-
#highlight_theme = "css"
22-
#highlight_themes_css = [
23-
# { theme = "base16-ocean-dark", filename = "syntax-theme-dark.css" },
24-
# { theme = "base16-ocean-light", filename = "syntax-theme-light.css" },
25-
#]
19+
theme = "catppuccin-mocha"
2620

2721
[link_checker]
2822
internal_level = "warn"

docs/content/documentation/content/linking.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ links working.
3434
It is possible to have Zola automatically insert anchor links next to the heading, as you can see on this documentation
3535
if you hover a title or covering the full heading text.
3636

37-
This option is set in the global [`config.toml`](@/documentation/getting-started/configuration/index.md)'s `[markdown]` section and can be overridden at the section level with the `insert_anchor_links` variable on the
37+
This option is set in the global [`config.toml`](@/documentation/getting-started/configuration.md)'s `[markdown]` section and can be overridden at the section level with the `insert_anchor_links` variable on the
3838
[section front matter page](@/documentation/content/section.md#front-matter).
3939

4040
The default template is very basic and will need CSS tweaks in your project to look decent.

docs/content/documentation/content/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ By default, this page's slug will be the directory name and thus its permalink w
6969
### Excluding files from assets
7070

7171
It is possible to ignore selected asset files using the
72-
[ignored_content](@/documentation/getting-started/configuration/index.md) setting in the config file.
72+
[ignored_content](@/documentation/getting-started/configuration.md) setting in the config file.
7373
For example, say that you have several code files which you are linking to on your website.
7474
For maintainability, you want to keep your code in the same directory as the Markdown file,
7575
but you don't want to copy the build folders to the public web site. You can achieve this by setting `ignored_content` in the config file:

docs/content/documentation/content/search.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ implements it (using elasticlunr) to get an idea: [search.js](https://github.com
1919

2020
## Configuring the search index
2121
In some cases, the default indexing strategy is not suitable. You can customize which fields to include and whether
22-
to truncate the content in the [search configuration](@/documentation/getting-started/configuration/index.md).
22+
to truncate the content in the [search configuration](@/documentation/getting-started/configuration.md).
2323

2424
## Index Formats
2525

0 commit comments

Comments
 (0)