From 1dd28182ce11f7a2fc81449666719736245f956e Mon Sep 17 00:00:00 2001 From: Henry Schreiner Date: Thu, 19 Mar 2026 11:03:49 -0400 Subject: [PATCH 1/2] fix: trim down Zensical, fix copyright year Signed-off-by: Henry Schreiner --- ...r.docs == 'zensical' %}index.md{% endif %} | 158 ----------- ...ocs == 'zensical' %}markdown.md{% endif %} | 109 -------- ...s == 'zensical' %}zensical.toml{% endif %} | 264 +----------------- 3 files changed, 2 insertions(+), 529 deletions(-) delete mode 100644 {{cookiecutter.project_name}}/docs/{% if cookiecutter.docs == 'zensical' %}markdown.md{% endif %} diff --git a/{{cookiecutter.project_name}}/docs/{% if cookiecutter.docs == 'zensical' %}index.md{% endif %} b/{{cookiecutter.project_name}}/docs/{% if cookiecutter.docs == 'zensical' %}index.md{% endif %} index 256eacd4..e1d20ba3 100644 --- a/{{cookiecutter.project_name}}/docs/{% if cookiecutter.docs == 'zensical' %}index.md{% endif %} +++ b/{{cookiecutter.project_name}}/docs/{% if cookiecutter.docs == 'zensical' %}index.md{% endif %} @@ -6,161 +6,3 @@ icon: lucide/rocket For full documentation visit [zensical.org](https://zensical.org/docs/). -## Commands - -- [`zensical new`][new] - Create a new project -- [`zensical serve`][serve] - Start local web server -- [`zensical build`][build] - Build your site - - [new]: https://zensical.org/docs/usage/new/ - [serve]: https://zensical.org/docs/usage/preview/ - [build]: https://zensical.org/docs/usage/build/ - -## Examples - -### Admonitions - -> Go to [documentation](https://zensical.org/docs/authoring/admonitions/) - -!!! note - - This is a **note** admonition. Use it to provide helpful information. - -!!! warning - - This is a **warning** admonition. Be careful! - -### Details - -> Go to -> [documentation](https://zensical.org/docs/authoring/admonitions/#collapsible-blocks) - -??? info "Click to expand for more info" - - This content is hidden until you click to expand it. - Great for FAQs or long explanations. - -## Code Blocks - -> Go to [documentation](https://zensical.org/docs/authoring/code-blocks/) - -```python hl_lines="2" title="Code blocks" -def greet(name): - print(f"Hello, {name}!") # (1)! - - -greet("Python") -``` - -1. > Go to - > [documentation](https://zensical.org/docs/authoring/code-blocks/#code-annotations) - - Code annotations allow to attach notes to lines of code. - -Code can also be highlighted inline: `#!python print("Hello, Python!")`. - -## Content tabs - -> Go to [documentation](https://zensical.org/docs/authoring/content-tabs/) - -=== "Python" - - ``` python - print("Hello from Python!") - ``` - -=== "Rust" - - ``` rs - println!("Hello from Rust!"); - ``` - -## Diagrams - -> Go to [documentation](https://zensical.org/docs/authoring/diagrams/) - -```mermaid -graph LR - A[Start] --> B{Error?}; - B -->|Yes| C[Hmm...]; - C --> D[Debug]; - D --> B; - B ---->|No| E[Yay!]; -``` - -## Footnotes - -> Go to [documentation](https://zensical.org/docs/authoring/footnotes/) - -Here's a sentence with a footnote.[^1] - -Hover it, to see a tooltip. - -[^1]: This is the footnote. - -## Formatting - -> Go to [documentation](https://zensical.org/docs/authoring/formatting/) - -- ==This was marked (highlight)== -- ^^This was inserted (underline)^^ -- ~~This was deleted (strikethrough)~~ -- H~2~O -- A^T^A -- ++ctrl+alt+del++ - -## Icons, Emojis - -> Go to [documentation](https://zensical.org/docs/authoring/icons-emojis/) - -- :sparkles: `:sparkles:` -- :rocket: `:rocket:` -- :tada: `:tada:` -- :memo: `:memo:` -- :eyes: `:eyes:` - -## Maths - -> Go to [documentation](https://zensical.org/docs/authoring/math/) - -$$ -\cos x=\sum_{k=0}^{\infty}\frac{(-1)^k}{(2k)!}x^{2k} -$$ - -!!! warning "Needs configuration" - - Note that MathJax is included via a `script` tag on this page and is not configured in the generated default configuration to avoid including it in a pages that do not need it. See the documentation for details on how to configure it on all your pages if they are more Maths-heavy than these simple starter pages. - - - - -## Task Lists - -> Go to -> [documentation](https://zensical.org/docs/authoring/lists/#using-task-lists) - -- [x] Install Zensical -- [x] Configure `zensical.toml` -- [x] Write amazing documentation -- [ ] Deploy anywhere - -## Tooltips - -> Go to [documentation](https://zensical.org/docs/authoring/tooltips/) - -[Hover me][example] - -[example]: https://example.com "I'm a tooltip!" diff --git a/{{cookiecutter.project_name}}/docs/{% if cookiecutter.docs == 'zensical' %}markdown.md{% endif %} b/{{cookiecutter.project_name}}/docs/{% if cookiecutter.docs == 'zensical' %}markdown.md{% endif %} deleted file mode 100644 index 1cc8d708..00000000 --- a/{{cookiecutter.project_name}}/docs/{% if cookiecutter.docs == 'zensical' %}markdown.md{% endif %} +++ /dev/null @@ -1,109 +0,0 @@ ---- -icon: simple/markdown ---- - -# Markdown in 5min - -## Headers - -``` -# H1 Header -## H2 Header -### H3 Header -#### H4 Header -##### H5 Header -###### H6 Header -``` - -## Text formatting - -``` -**bold text** -*italic text* -***bold and italic*** -~~strikethrough~~ -`inline code` -``` - -## Links and images - -``` -[Link text](https://example.com) -[Link with title](https://example.com "Hover title") -![Alt text](image.jpg) -![Image with title](image.jpg "Image title") -``` - -## Lists - -``` -Unordered: -- Item 1 -- Item 2 - - Nested item - -Ordered: -1. First item -2. Second item -3. Third item -``` - -## Blockquotes - -``` -> This is a blockquote -> Multiple lines ->> Nested quote -``` - -## Code blocks - -```` -```javascript -function hello() { - console.log("Hello, world!"); -} -``` -```` - -## Tables - -``` -| Header 1 | Header 2 | Header 3 | -|----------|----------|----------| -| Row 1 | Data | Data | -| Row 2 | Data | Data | -``` - -## Horizontal rule - -``` ---- -or -*** -or -___ -``` - -## Task lists - -``` -- [x] Completed task -- [ ] Incomplete task -- [ ] Another task -``` - -## Escaping characters - -``` -Use backslash to escape: \* \_ \# \` -``` - -## Line breaks - -``` -End a line with two spaces -to create a line break. - -Or use a blank line for a new paragraph. -``` diff --git a/{{cookiecutter.project_name}}/{% if cookiecutter.docs == 'zensical' %}zensical.toml{% endif %} b/{{cookiecutter.project_name}}/{% if cookiecutter.docs == 'zensical' %}zensical.toml{% endif %} index 497fa6d1..cc62986c 100644 --- a/{{cookiecutter.project_name}}/{% if cookiecutter.docs == 'zensical' %}zensical.toml{% endif %} +++ b/{{cookiecutter.project_name}}/{% if cookiecutter.docs == 'zensical' %}zensical.toml{% endif %} @@ -1,262 +1,34 @@ -# ============================================================================ -# -# The configuration produced by default is meant to highlight the features -# that Zensical provides and to serve as a starting point for your own -# projects. -# -# ============================================================================ +# Read more: https://zensical.org/docs/setup/basics [project] - -# The site_name is shown in the page header and the browser window title -# -# Read more: https://zensical.org/docs/setup/basics/#site_name site_name = "{{ cookiecutter.project_name }}" - -# The site_description is included in the HTML head and should contain a -# meaningful description of the site content for use by search engines. -# -# Read more: https://zensical.org/docs/setup/basics/#site_description site_description = "{{ cookiecutter.project_short_description }}" - -# The site_author attribute. This is used in the HTML head element. -# -# Read more: https://zensical.org/docs/setup/basics/#site_author site_author = "{{ cookiecutter.full_name }}" - -# The site_url is the canonical URL for your site. When building online -# documentation you should set this. -# Read more: https://zensical.org/docs/setup/basics/#site_url -#site_url = "https://www.example.com/" - -# The copyright notice appears in the page footer and can contain an HTML -# fragment. -# -# Read more: https://zensical.org/docs/setup/basics/#copyright copyright = """ -Copyright © 2026 The authors +Copyright © {{ cookiecutter.__year }} The authors """ -# Zensical supports both implicit navigation and explicitly defined navigation. -# If you decide not to define a navigation here then Zensical will simply -# derive the navigation structure from the directory structure of your -# "docs_dir". The definition below demonstrates how a navigation structure -# can be defined using TOML syntax. -# -# Read more: https://zensical.org/docs/setup/navigation/ -# nav = [ -# { "Get started" = "index.md" }, -# { "Markdown in 5min" = "markdown.md" }, -# ] - -# With the "extra_css" option you can add your own CSS styling to customize -# your Zensical project according to your needs. You can add any number of -# CSS files. -# -# The path provided should be relative to the "docs_dir". -# -# Read more: https://zensical.org/docs/customization/#additional-css -# -#extra_css = ["stylesheets/extra.css"] - -# With the `extra_javascript` option you can add your own JavaScript to your -# project to customize the behavior according to your needs. -# -# The path provided should be relative to the "docs_dir". -# -# Read more: https://zensical.org/docs/customization/#additional-javascript -#extra_javascript = ["javascripts/extra.js"] - -# ---------------------------------------------------------------------------- -# Section for configuring theme options -# ---------------------------------------------------------------------------- [project.theme] - -# change this to "classic" to use the traditional Material for MkDocs look. -#variant = "classic" - -# Zensical allows you to override specific blocks, partials, or whole -# templates as well as to define your own templates. To do this, uncomment -# the custom_dir setting below and set it to a directory in which you -# keep your template overrides. -# -# Read more: -# - https://zensical.org/docs/customization/#extending-the-theme -# -#custom_dir = "overrides" - -# With the "favicon" option you can set your own image to use as the icon -# browsers will use in the browser title bar or tab bar. The path provided -# must be relative to the "docs_dir". -# -# Read more: -# - https://zensical.org/docs/setup/logo-and-icons/#favicon -# - https://developer.mozilla.org/en-US/docs/Glossary/Favicon -# -#favicon = "images/favicon.png" - -# Zensical supports more than 60 different languages. This means that the -# labels and tooltips that Zensical's templates produce are translated. -# The "language" option allows you to set the language used. This language -# is also indicated in the HTML head element to help with accessibility -# and guide search engines and translation tools. -# -# The default language is "en" (English). It is possible to create -# sites with multiple languages and configure a language selector. See -# the documentation for details. -# -# Read more: -# - https://zensical.org/docs/setup/language/ -# language = "en" - -# Zensical provides a number of feature toggles that change the behavior -# of the documentation site. features = [ - # Zensical includes an announcement bar. This feature allows users to - # dismiss it when they have read the announcement. - # https://zensical.org/docs/setup/header/#announcement-bar "announce.dismiss", - - # If you have a repository configured and turn on this feature, Zensical - # will generate an edit button for the page. This works for common - # repository hosting services. - # https://zensical.org/docs/setup/repository/#code-actions - #"content.action.edit", - - # If you have a repository configured and turn on this feature, Zensical - # will generate a button that allows the user to view the Markdown - # code for the current page. - # https://zensical.org/docs/setup/repository/#code-actions - #"content.action.view", - - # Code annotations allow you to add an icon with a tooltip to your - # code blocks to provide explanations at crucial points. - # https://zensical.org/docs/authoring/code-blocks/#code-annotations "content.code.annotate", - - # This feature turns on a button in code blocks that allow users to - # copy the content to their clipboard without first selecting it. - # https://zensical.org/docs/authoring/code-blocks/#code-copy-button "content.code.copy", - - # Code blocks can include a button to allow for the selection of line - # ranges by the user. - # https://zensical.org/docs/authoring/code-blocks/#code-selection-button "content.code.select", - - # Zensical can render footnotes as inline tooltips, so the user can read - # the footnote without leaving the context of the document. - # https://zensical.org/docs/authoring/footnotes/#footnote-tooltips "content.footnote.tooltips", - - # If you have many content tabs that have the same titles (e.g., "Python", - # "JavaScript", "Cobol"), this feature causes all of them to switch to - # at the same time when the user chooses their language in one. - # https://zensical.org/docs/authoring/content-tabs/#linked-content-tabs "content.tabs.link", - - # TODO: not sure I understand this one? Is there a demo of this in the docs? - # https://zensical.org/docs/authoring/tooltips/#improved-tooltips "content.tooltips", - - # With this feature enabled, Zensical will automatically hide parts - # of the header when the user scrolls past a certain point. - # https://zensical.org/docs/setup/header/#automatic-hiding - # "header.autohide", - - # Turn on this feature to expand all collapsible sections in the - # navigation sidebar by default. - # https://zensical.org/docs/setup/navigation/#navigation-expansion - # "navigation.expand", - - # This feature turns on navigation elements in the footer that allow the - # user to navigate to a next or previous page. - # https://zensical.org/docs/setup/footer/#navigation "navigation.footer", - - # When section index pages are enabled, documents can be directly attached - # to sections, which is particularly useful for providing overview pages. - # https://zensical.org/docs/setup/navigation/#section-index-pages "navigation.indexes", - - # When instant navigation is enabled, clicks on all internal links will be - # intercepted and dispatched via XHR without fully reloading the page. - # https://zensical.org/docs/setup/navigation/#instant-navigation "navigation.instant", - - # With instant prefetching, your site will start to fetch a page once the - # user hovers over a link. This will reduce the perceived loading time - # for the user. - # https://zensical.org/docs/setup/navigation/#instant-prefetching "navigation.instant.prefetch", - - # In order to provide a better user experience on slow connections when - # using instant navigation, a progress indicator can be enabled. - # https://zensical.org/docs/setup/navigation/#progress-indicator - #"navigation.instant.progress", - - # When navigation paths are activated, a breadcrumb navigation is rendered - # above the title of each page - # https://zensical.org/docs/setup/navigation/#navigation-path "navigation.path", - - # When pruning is enabled, only the visible navigation items are included - # in the rendered HTML, reducing the size of the built site by 33% or more. - # https://zensical.org/docs/setup/navigation/#navigation-pruning - #"navigation.prune", - - # When sections are enabled, top-level sections are rendered as groups in - # the sidebar for viewports above 1220px, but remain as-is on mobile. - # https://zensical.org/docs/setup/navigation/#navigation-sections "navigation.sections", - - # When tabs are enabled, top-level sections are rendered in a menu layer - # below the header for viewports above 1220px, but remain as-is on mobile. - # https://zensical.org/docs/setup/navigation/#navigation-tabs - #"navigation.tabs", - - # When sticky tabs are enabled, navigation tabs will lock below the header - # and always remain visible when scrolling down. - # https://zensical.org/docs/setup/navigation/#sticky-navigation-tabs - #"navigation.tabs.sticky", - - # A back-to-top button can be shown when the user, after scrolling down, - # starts to scroll up again. - # https://zensical.org/docs/setup/navigation/#back-to-top-button "navigation.top", - - # When anchor tracking is enabled, the URL in the address bar is - # automatically updated with the active anchor as highlighted in the table - # of contents. - # https://zensical.org/docs/setup/navigation/#anchor-tracking "navigation.tracking", - - # When search highlighting is enabled and a user clicks on a search result, - # Zensical will highlight all occurrences after following the link. - # https://zensical.org/docs/setup/search/#search-highlighting "search.highlight", - - # When anchor following for the table of contents is enabled, the sidebar - # is automatically scrolled so that the active anchor is always visible. - # https://zensical.org/docs/setup/navigation/#anchor-following - # "toc.follow", - - # When navigation integration for the table of contents is enabled, it is - # always rendered as part of the navigation sidebar on the left. - # https://zensical.org/docs/setup/navigation/#navigation-integration - #"toc.integrate", ] -# ---------------------------------------------------------------------------- -# In the "palette" subsection you can configure options for the color scheme. -# You can configure different color # schemes, e.g., to turn on dark mode, -# that the user can switch between. Each color scheme can be further -# customized. -# -# Read more: -# - https://zensical.org/docs/setup/colors/ -# ---------------------------------------------------------------------------- [[project.theme.palette]] scheme = "default" toggle.icon = "lucide/sun" @@ -267,38 +39,6 @@ scheme = "slate" toggle.icon = "lucide/moon" toggle.name = "Switch to light mode" -# ---------------------------------------------------------------------------- -# In the "font" subsection you can configure the fonts used. By default, fonts -# are loaded from Google Fonts, giving you a wide range of choices from a set -# of suitably licensed fonts. There are options for a normal text font and for -# a monospaced font used in code blocks. -# ---------------------------------------------------------------------------- -#[project.theme.font] -#text = "Inter" -#code = "Jetbrains Mono" - -# ---------------------------------------------------------------------------- -# You can configure your own logo to be shown in the header using the "logo" -# option in the "icons" subsection. The logo can be a path to a file in your -# "docs_dir" or it can be a path to an icon. -# -# Likewise, you can customize the logo used for the repository section of the -# header. Zensical derives the default logo for this from the repository URL. -# See below... -# -# There are other icons you can customize. See the documentation for details. -# -# Read more: -# - https://zensical.org/docs/setup/logo-and-icons -# - https://zensical.org/docs/authoring/icons-emojis/#search -# ---------------------------------------------------------------------------- -#[project.theme.icon] -#logo = "lucide/smile" -#repo = "lucide/smile" - -# ---------------------------------------------------------------------------- -# The "extra" section contains miscellaneous settings. -# ---------------------------------------------------------------------------- [[project.extra.social]] icon = "fontawesome/brands/github" link = "{{ cookiecutter.url }}" From f8a1489388b8e7a41fcd7d1aae68596a099d9872 Mon Sep 17 00:00:00 2001 From: Henry Schreiner Date: Thu, 19 Mar 2026 11:28:59 -0400 Subject: [PATCH 2/2] Update documentation index with new link --- .../{% if cookiecutter.docs == 'zensical' %}index.md{% endif %} | 1 - 1 file changed, 1 deletion(-) diff --git a/{{cookiecutter.project_name}}/docs/{% if cookiecutter.docs == 'zensical' %}index.md{% endif %} b/{{cookiecutter.project_name}}/docs/{% if cookiecutter.docs == 'zensical' %}index.md{% endif %} index e1d20ba3..ad8966e6 100644 --- a/{{cookiecutter.project_name}}/docs/{% if cookiecutter.docs == 'zensical' %}index.md{% endif %} +++ b/{{cookiecutter.project_name}}/docs/{% if cookiecutter.docs == 'zensical' %}index.md{% endif %} @@ -5,4 +5,3 @@ icon: lucide/rocket # Get started For full documentation visit [zensical.org](https://zensical.org/docs/). -