Skip to content

LilithHafner/DocumenterVitepress.jl

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

64 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DocumenterVitepress.jl

This package provides a Markdown / MkDocs backend to Documenter.jl.

Installation

The package can be added using the Julia package manager. From the Julia REPL, type ] to enter the Pkg REPL mode and run

pkg> add DocumenterVitepress

Usage

To enable the backend import the package in make.jl and then just pass format = DocumenterVitepress.MarkdownVitepress() to makedocs:

using Documenter
using DocumenterVitepress
makedocs(;
    format=DocumenterVitepress.MarkdownVitepress(),
    )

Run locally

npm dependencies

docs > npm i

run docs locally

docs> npm run docs:dev 

The documentation needs documentation.

-a Bellevue Linux Users Group member, 2005-

About

Documentation with Documenter.jl and VitePress

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Julia 100.0%