@sys/driver-vitepress@0.0.70Built and signed on GitHub ActionsBuilt and signed on GitHub Actions
Tools for working with the VitePress documentation SSG (static-site-generator).
VitePress Driver
Tools for working with the "VitePress" documentation SSG (static-site-generator).
Initialize a folder as a VitePress project.
Initialize a folder as a VitePress project.
To initialize a new content-transpiler project start by scaffolding out a runtime folder:
By default, the source content will be housed within /docs
folder. All
programmatic modules (with the exceptions of highlevel configuration .ts files)
are housed within .hidden
folders and auto-updatable via deno task upgrade
.
Turn the current working directory into a content project.
deno run -A jsr:@sys/driver-vitepress/init
Once the project is initialized, use the three main commands dev
, build
and serve
via the deno task
command.
To run in development while authoring your content, run:
deno task dev
this will start the HMR (hot-module-reload) development server:
vitepress v<X.X.X> ➜ Local: http://localhost:1234/ ➜ Network: use --host to expose
Open the web-browser at http://localhost:1234/
You can now move over to Obsidian (or any other markdown editor of choice)
to author and manage your content within the /docs/
folder.
The running HMR (hot-module-reload) the server will display the rendered result in your browser, live updating on each edit you make.
Once ready to release, build
the content into a package/bundle to deploy to the cloud.
You can test it locally using the local serve
command:
deno task build deno task serve
See the dist/dist.json
file for the SHA256 content hash and module
manifest of the versioned bundled. This can be used as a
These are published in HTTP headers:
pkg: { name, version } pkg-digest: digest:sha256:#
Add Package
deno add jsr:@sys/driver-vitepress
Import symbol
import * as driver_vitepress from "@sys/driver-vitepress";
---- OR ----
Import directly with a jsr specifier
import * as driver_vitepress from "jsr:@sys/driver-vitepress";