@mirascope/docs-viewer v0.4.9
Mirascope Standalone Docs Viewer
Development
This is a fork of mirascope/website which instantiates a standalone docs viewer.
The goal is to assist mirascope/mirascope development by allowing developing docs alongside the project without merging them into the main site.
For general information, see the mirascope/website repo.
This is intended as dev-tooling only and not maintained at a level of production quality.
Setup
This project uses Bun - a fast all-in-one JavaScript runtime and toolkit.
# Install dependencies
bun install
# Start development server
bun run start --content-dir path/to/contentUsage
The project is currently used in the mirascope v2 repo with a package json like this:
{
"name": "mirascope",
"private": true,
"scripts": {
"preprocess": "DOCS_VIEWER_DIR=node_modules/@mirascope/docs-viewer bun node_modules/@mirascope/docs-viewer/scripts/preprocess-content.ts --content-dir mirascope/experimental/v2",
"start": "DOCS_VIEWER_DIR=node_modules/@mirascope/docs-viewer bun node_modules/@mirascope/docs-viewer/scripts/start.ts --content-dir mirascope/experimental/v2",
},
"devDependencies": {
"@mirascope/docs-viewer": "^0.1.5",
}
}Upcoming Development
I want to figure out how to integrate the api generation to produce up-to-date api docs for mirascope v2.
License
Everything in this repository is licensed under the MIT License except for "Williams-Handwriting-Regular-v1.tff", which is a closed license font and not available for use without express permission.
10 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago