Lore#

Quick Start#

# run lore in your docs directory
bunx @tayacrystals/lore

# now you have a build in ./build

# to start a dev server use
bunx @tayacrystals/lore dev

Features#

• Zero setup docs, just one command
• MDX support, with custom components
• Plugins
• Dark/Light mode with system preference detection
• Full-text search powered by pagefind

Next Steps#

Explore the documentation to learn more:

• File Structure - How to organize your documentation
• Configuration - Customize your site
• Writing Content - Author documentation pages
• Plugins - Using and creating Lore plugins
• Components - Using and creating MDX components
• Deployment - Publish your docs to GitHub Pages