Neko

Changelog

Neko is currently under active development.

Please note that Neko uses a calendar versioning approach.

v26.3.16

  • Feature: Added a new component for rendering PDF files inline in the text. You can now use the standard markdown image syntax pointing to a .pdf file to automatically render it in an iframe using pdf.js.

v26.3.12

  • Feature: Added support for configuring a global password in neko.yml. You can now protect the entire documentation by defining password: "my-secret" in your global configuration. Individual pages can bypass this global protection by setting password: none in their frontmatter.
  • Documentation: Updated the Tesserae component documentation (components/tesserae.md) to include a full interactive TODO sample application that demonstrates building UI components and persisting state via window.localStorage.

v26.3.11

  • Feature: Added csharp-docs code block language mode which leverages Roslyn to parse C# code blocks containing XML comments and beautifully renders them with DocFx-like layouts detailing the summary, parameters, remarks, return types, and exceptions.
  • Feature: Added a sitemap boolean configuration option in neko.yml to automatically generate a sitemap.xml file containing all generated HTML pages, utilizing the configured url as the base address.
  • Improvement: Made the sidebar search box sticky when scrolling the sidebar, allowing quick access to the filter functionality. This was achieved by updating the HTML generation in Neko/Builder/HtmlGenerator.cs to wrap the search input in a sticky container while maintaining the proper layout for the rest of the navigation list.
  • Feature: Added Monaco Editor support for auto-completing templates for all valid components of neko starting with the "neko-" prefix. The template list is loaded dynamically from templates.json on the first render of the editor.
  • Documentation: Added a new guide for the Live Editing feature in Watch mode, including details on auto-completing templates.

v26.3.3

Snapframe Component

  • Added a new [!snapframe] Markdown extension that automatically generates screenshots of external websites using the SnapFrame .NET tool during the build process.
  • Extended the [!snapframe] Markdown extension to support multi-line command execution, allowing interaction with the page before taking the screenshot.
  • Merged the image alignment documentation into the main image.md file.

v26.3

Icon Search in Watch Mode Editor

  • Added a searchable list of icons in the watch mode editor modal.
  • Accessible via the Ctrl+I or Cmd+I keyboard shortcut.
  • Allows inserting the selected icon's name directly into the editor at the current cursor position.

Workflow LeaderLines Clipping Improvements

  • Modified the workflow component javascript to appropriately clip connection lines within the workflow container.

Mermaid Diagram Zoom Controls

  • Added built-in zoom controls to Mermaid diagrams.
  • Hover over any Mermaid diagram to access Zoom In, Zoom Out, and Reset buttons.
  • Applied a minimum height of 400px to all Mermaid diagrams to give ample space for interacting with diagrams.

Initial Release of Neko v26.3

We are excited to announce the initial release of Neko, a powerful static site generator designed to help you create beautiful, documentation-first websites with ease.

Key Features

  • Markdown First: Write your documentation in standard Markdown. Neko handles the rest.
  • Rich Components: Enhance your docs with built-in components like Alerts, Badges, Tabs, and more.
  • Theming: Dynamic Tailwind themes configurable via neko.yml under the theme key. Users can specify a built-in palette (e.g., name: violet) and override specific shades.
  • Blog Support: Neko supports a 'Blog Mode' where files in a blog/ directory are processed as posts, sorted by date (descending), and displayed in a responsive grid layout of cards.
  • Changelog Support: Neko supports a 'Changelog Mode' where files in a changelog/ directory are processed as entries, sorted by date (descending), and displayed in a vertical timeline layout.
  • Watch Mode: The CLI supports a watch command that serves the site on localhost and auto-reloads on file changes, including a built-in Monaco editor for quick edits.
  • Multi-Repo Mode: Simultaneously build, watch, and serve multiple sub-projects located in immediate subdirectories containing a neko.yml file.
  • Tesserae Support: Write and compile Tesserae C# code blocks directly in your Markdown, generating live interactive components.

Other Important Features

  • Markdown Custom Containers: Support for custom Markdown syntax like Icons, Badges, Alerts, Tabs, Columns, Steps, Generic Components, Code Snippets, Panels, Emojis, and Cards.
  • Navigation History: Tracks the last visited pages in browser localStorage, with a flyover popup UI.
  • Built-in Search: Full-text client-side search across your documentation using Minisearch.
  • Dynamic Card Backgrounds: makegradient.js integration for beautiful, dynamic card backgrounds.
  • Mathematical Formulas & Diagrams: Integrated support for KaTeX math formulas and Mermaid diagrams.