Skip to content

Commit

Permalink
🐛 docs(ToC): fix broken code block
Browse files Browse the repository at this point in the history
  • Loading branch information
welpo committed Sep 8, 2023
1 parent 695e40b commit 3f2e456
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 6 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ tabi has a perfect score on Google's Lighthouse audit:

## Features

- [X] Multi-language support.
- [X] Full multi-language support. Set as many languages to your site as you wish.
- [X] Single non-English language support. Set your entire site to Chinese, Spanish, French, Russian… or any [other supported language](/i18n).
- [X] Dark and light themes. Defaults to the OS setting, with a switcher in the navigation bar.
- [X] Support for [comments using giscus, utterances, Hyvor Talk, or Isso](https://welpo.github.io/tabi/blog/comments/).
- [X] Perfect Lighthouse score (Performance, Accessibility, Best Practices and SEO).
Expand Down Expand Up @@ -112,7 +113,9 @@ The content outside the front matter will be rendered between the header title a
- set the title and taxonomies for each language;
- add the `language_name.{code}` in `[extra]`. This is the text shown in the language switcher.

See [these lines in the provided `config.toml`](https://github.com/welpo/tabi/blob/main/config.toml#L22-L134) for an example.
TODO: Mention i18n/

See [these lines in the provided `config.toml`](https://github.com/welpo/tabi/blob/main/config.toml#L21-L43) for an example.

You will need an `_index.{language_code}.md` per language for each section (e.g. /blog or /projects) that you want to enable in that language.

Expand All @@ -130,7 +133,11 @@ This theme was inspired by:

## Contributing

Please do! Take a look at the [Contributing Guidelines](/CONTRIBUTING.md) to learn more.
Please do!

TODO: we appreciate bug reports, translations, documentation improvements, and pull requests.

Take a look at the [Contributing Guidelines](/CONTRIBUTING.md) to learn more.

## License

Expand Down
4 changes: 3 additions & 1 deletion content/blog/toc.ca.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
+++
title = "Taula de contingut"
date = 2022-11-01
updated = 2023-08-14
updated = 2023-09-08
description = "Una publicació que mostra la taula de contingut opcional i la seva configuració."

[taxonomies]
Expand Down Expand Up @@ -52,11 +52,13 @@ El codi per aconseguir-ho:
Si col·loques la TdC en un lloc diferent del predeterminat i li afegeixes un capçalera, segurament voldràs ocultar aquest capçalera de la TdC (consulta la [secció per ocultar capçaleres](#ocultant-capcaleres-de-la-tdc)). Pots fer-ho així:

```markdown,hl_lines=06 11-13
+++
title = "El títol del teu post"
date = 2034-01-11
[extra]
toc_ignore_pattern = "^(Taula de contingut)"
+++
Aquí va algun text introductori.
Expand Down
4 changes: 3 additions & 1 deletion content/blog/toc.es.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
+++
title = "Tabla de contenido"
date = 2022-11-01
updated = 2023-08-14
updated = 2023-09-08
description = "Una publicación que muestra la tabla de contenido opcional así como su configuración."

[taxonomies]
Expand Down Expand Up @@ -52,11 +52,13 @@ El código para lograr esto:
Si colocas la TdC en algún lugar distinto al predeterminado y le añades un encabezado, seguramente quieras ocultar dicho encabezado de la TdC (consulta la [sección para ocultar encabezados](#ocultando-encabezados-de-la-tdc)). Puedes lograrlo así:

```markdown,hl_lines=06 11-13
+++
title = "El título de tu post"
date = 2034-01-11
[extra]
toc_ignore_pattern = "^(Tabla de contenido)"
+++
Aquí va algún texto introductorio.
Expand Down
4 changes: 3 additions & 1 deletion content/blog/toc.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
+++
title = "Table of Contents"
date = 2022-11-01
updated = 2023-08-14
updated = 2023-09-08
description = "A post showcasing the optional Table of Contents and its options."

[taxonomies]
Expand Down Expand Up @@ -51,11 +51,13 @@ The code to achieve this:
If you set a custom position and a custom header for the ToC, you'll probably want to hide it (see the [section below](#hiding-headers-from-the-toc)) like this:

```markdown,hl_lines=06 11-13
+++
title = "Your Post's Title"
date = 2034-01-11
[extra]
toc_ignore_pattern = "^(Table of Contents)"
+++
Here goes some introductory text.
Expand Down

0 comments on commit 3f2e456

Please sign in to comment.