Skip to content

universal-ember/kolay

Folders and files

NameName
Last commit message
Last commit date
Sep 15, 2024
Nov 3, 2024
Nov 2, 2024
Jul 11, 2024
Nov 2, 2024
Nov 2, 2024
Nov 1, 2024
Nov 1, 2024
Nov 1, 2024
Nov 1, 2024
Feb 11, 2024
Nov 1, 2024
Nov 1, 2024
Oct 29, 2024
Nov 1, 2024
Oct 29, 2024
Nov 1, 2024
Nov 1, 2024
Mar 6, 2024
Dec 26, 2023
Nov 1, 2024
Nov 1, 2024
Nov 3, 2024
Nov 3, 2024
Feb 11, 2024
Nov 2, 2024
Nov 2, 2024
Mar 16, 2024
Nov 1, 2024
Mar 16, 2024

Repository files navigation

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
    Some prose here about the demo
    
    ```gjs live
    <template>
      interactive!
    </template>
    ```

Use JSDoc

  • JSDoc / TypeDoc is renderable via the <APIDocs /> component
    ## API Reference
    
    <APIDocs @package="my-library" @module="..." @name="theExport" />
  • 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