https://github.com/firesquid6/inkdocs

A hypertext based documentation site builder. Powered by bun and htmx.
https://github.com/firesquid6/inkdocs

bun bunjs documentation documentation-generator documentation-site html htmx markdown static-site-generator typescript

Last synced: 2 months ago
JSON representation

A hypertext based documentation site builder. Powered by bun and htmx.

• Host: GitHub
• URL: https://github.com/firesquid6/inkdocs
• Owner: FireSquid6
• Created: 2023-12-07T05:06:31.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-24T23:37:11.000Z (3 months ago)
• Last Synced: 2024-11-07T10:03:11.361Z (2 months ago)
• Topics: bun, bunjs, documentation, documentation-generator, documentation-site, html, htmx, markdown, static-site-generator, typescript
• Language: TypeScript
• Homepage: https://inkdocs.vercel.app
• Size: 1.45 MB
• Stars: 8
• Watchers: 2
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Inkdocs

Inkdocs is a static site generator built for documentation. It is currently in early development with an expected 1.0 release at the end of February 2024. It is actively maintained by [firesquid](https://github.com/firesquid6) with help from others from [Hack Club](https://github.com/hackclub).

## Features

- uses no framework. It ships **0** javascript to the frontend by default, and only ships htmx if you use the swap router.

- ships your docs as a multi page application and does server side routing

- uses markdown by default, but can use any other markup if you have a parser for it.

- can be extensively styled and customized or just used out of the box.

- can be easily extended with plugins to add hyperscript, tailwind, or any other functionality you may need

Coming soon:

- internationalization plugin

## The Swap Router

While the swap router is an optional "plugin," it is the main brain of Inkdocs and it is recommended that you use it. The swap router uses htmx to hijack all `a` tags in your page and make them only swap out the content that's changing. Let's imagine the follwoing html page:

```html

    Example Inkdocs

    

    

    
Pretend I'm some really cool sidebar

    

        
Blog

        
This is some blog stuff you may need idk

        Back to the docs

        Check Out Another Blog Post