https://github.com/universal-ember/kolay

Docs system based on markdown files living in the public folder.
https://github.com/universal-ember/kolay

addon docgen docs documentation ember ember-addon markdown md rollup unplugin vite webpack

Last synced: about 2 months ago
JSON representation

Docs system based on markdown files living in the public folder.

• Host: GitHub
• URL: https://github.com/universal-ember/kolay
• Owner: universal-ember
• Created: 2023-12-26T01:25:26.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-11-07T03:18:18.000Z (about 2 months ago)
• Last Synced: 2024-11-07T03:30:42.080Z (about 2 months ago)
• Topics: addon, docgen, docs, documentation, ember, ember-addon, markdown, md, rollup, unplugin, vite, webpack
• Language: TypeScript
• Homepage: https://kolay.nullvoxpopuli.com
• Size: 1.77 MB
• Stars: 6
• Watchers: 0
• Forks: 2
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# kolay

Documentation system for the the `@universal-ember` family of projects.

## Features

### Use Markdown

- from any folder, any project (good for monorepos)

- scales infinitely with your project size, as compiling the pages is done on-demand, rather than on-deploy

- any codefence can become a live demo with the `live` tag

  ~~~md

  Some prose here about the demo

  ```gjs live

  

    interactive!

  

  ```

  ~~~

### Use JSDoc

- JSDoc / TypeDoc is renderable via the `` component

  ~~~md

  ## API Reference

  

  ~~~

- render examples from your jsdoc for interactive demonstration of concepts using 

  ~~~

  text here

  ```gjs live

  // the "live" tag on the codefence

  ```

  ~~~

### Navigation 

- generate navigation based on convention based file layout