https://github.com/vycke/dockit

https://github.com/vycke/dockit

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/vycke/dockit
• Owner: vycke
• License: mit
• Created: 2021-06-27T19:29:43.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-01-20T18:46:03.000Z (almost 3 years ago)
• Last Synced: 2024-08-13T02:16:14.699Z (5 months ago)
• Language: Svelte
• Homepage: https://dockit.crinkles.io
• Size: 235 KB
• Stars: 29
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-svelte-kit - Dockit - Markdown-based document site (📦 Built With Svelte / Open-Source Projects)

README

        
# Dockit - Simple markdown based document site.

Dockit is a simple application template for building (responsive) document websites based on markdown files.

## Features

- Simply put all documentation as `.md` files in the `/docs` directory

- Auto-generated navigation based on `title` and `category` settings in the frontmatter of the markdown files. If required, you can set an `order` attribute on articles which will take preference over the title, within a group.

- Set category icons in the `src/lib/constants.js` file (based on [feathericons](https://feathericons.com))

- Change the name, version & source code link in the `src/lib/constants.js` file.

- Light and dark modes, starting on browser preference

- Search on titles and sub titles of the different documents

## Users

- [Feo CSS](https://github.com/crinklesio/feo-css)

- [SvelteKit](https://kit.svelte.dev)

- [Feather icons](https://feathericons.com)