Skip to content

Latest commit

 

History

History
46 lines (33 loc) · 2.54 KB

README.md

File metadata and controls

46 lines (33 loc) · 2.54 KB

🌕 Lucero

Documentation playground using starlight and starlight-openapi.

Built with Starlight

Starlight Deets

Starlight looks for .md or .mdx files in the src/content/docs/ directory. Each file is exposed as a route based on its file name.

Images can be added to src/assets/ and embedded in Markdown with a relative link.

Static assets, like favicons, can be placed in the public/ directory.


Commands

Warning

This repo uses the Deno runtime.

All commands are run from the root of the project, from a terminal:

command action
deno install --allow-scripts Installs dependencies
deno task dev Starts local dev server at localhost:4321
deno task build Build your production site to ./dist/
deno task preview Preview your build locally, before deploying
deno task astro ... Run CLI commands like astro add, astro check
deno task astro -- --help Get help using the Astro CLI
deno run -A npm:@astrojs/upgrade "Update" Astro dependencies, use the command below to bump or install the dependencies.
deno add npm:<package>[@<version>] Add/Upgrade package

To Do

  • Add Tailwind CSS (Wait till next version, so configuration can be in a CSS file?)
  • Custom palette (dark/light)
  • Create Expressive Code Theme
  • Add RSS feed
  • Create customizable components
    • Stoplight Elements
    • RapiDoc
  • new projects
    • Fork to create a Deno Starlight starter kit.
    • Fork to create a version that overrides the starlight components with simpler semantic versions.