Skip to content

Nucleify/nuc_documentation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

35 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

  nuc_documentation

Module that provides Markdown-based documentation pages with SSR/prerendering support.

Features

  • Category-based organization - Documentation organized by categories with nested pages
  • SSR & Prerendering - Content is prerendered for instant loading
  • Table of Contents - Auto-generated TOC with scroll tracking
  • Syntax highlighting - Code blocks with highlight.js
  • Client-side navigation - Fast navigation between pages via NuxtLink
  • Prefetching - Background prefetch of documentation content
  • Responsive design - Works on desktop and mobile

Usage

  1. Create .md files in content/{category}/
  2. Register pages in DOC_CATEGORIES constant (atomic/bosons/constants/documentation.ts)

Utils

Function Description
parseDocPath Parse URL path to category/slug
parseMarkdown Convert markdown to HTML
parseHeadings Extract headings from HTML
loadDocContentServer Load content during SSR
loadDocContentClient Load content on client
useHeadings Scroll tracking for TOC
useDocumentation Prefetch helpers

    Contributors


About

Module that contains Nucleify's documentation functions.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors