docusaurus
This module allows you to run docusaurus sites locally with Dagger without needing to install any additional dependencies.Installation
dagger install github.com/levlaz/daggerverse/docusaurus@v0.1.0
Entrypoint
Return Type
Docusaurus
Example
dagger -m github.com/levlaz/daggerverse/docusaurus@68454a40a9aa2fb2a02cfc07fe3aea3b09c5be85 call \
func (m *myModule) example() *Docusaurus {
return dag.
Docusaurus()
}
@function
def example() -> dag.Docusaurus:
return (
dag.docusaurus()
)
@func()
example(): Docusaurus {
return dag
.docusaurus()
}
Types
Docusaurus 🔗
run() 🔗
Run docs site locally
Return Type
Container !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
src | Directory ! | - | The source directory of your docusaurus site, this can be a local directory or a remote git repo |
dir | String ! | "/src" | Optional working directory if you need to execute docusaurus commands outside of your root |
Example
dagger -m github.com/levlaz/daggerverse/docusaurus@68454a40a9aa2fb2a02cfc07fe3aea3b09c5be85 call \
run --src DIR_PATH --dir string
func (m *myModule) example(src *Directory, dir string) *Container {
return dag.
Docusaurus().
Run(src, dir)
}
@function
def example(src: dagger.Directory, dir: str) -> dagger.Container:
return (
dag.docusaurus()
.run(src, dir)
)
@func()
example(src: Directory, dir: string): Container {
return dag
.docusaurus()
.run(src, dir)
}