class Vitepressify::Vitepress

Overview

Responsible for the content and locations of the Vitepress project structure.

Defined in:

vitepressify/vitepress.cr

Constant Summary

STRUCTURE = {config: Path["docs", ".vitepress", "config.js"], sidebars: Path["docs", ".vitepress", "crystal"], readme: Path["docs", "index.md"], root: Path["docs"], package_json: Path["package.json"], theme: Path["docs", ".vitepress", "theme"]}

Locations of files in Vitepress project.

Constructors

Instance Method Summary

Constructor Detail

def self.new(name : String, dir : Path) #

[View source]

Instance Method Detail

def config #

.vitepress/config.js


[View source]
def create_structure #

Creates the project structure folders.


[View source]
def package_json #

package.json


[View source]
def sidebar_import #

The import portion of .vitepress/config.js. It imports and parses all the sidebars.


[View source]
def sidebar_name #

The name at the sidebar json.


[View source]
def sidebar_nav_gen #

The sidebar and nav portion of .vitepress/config.js. It handles their structure based on the amount of children.


[View source]
def theme_config #

.vitepress/theme/config.js


[View source]
def theme_css #

.vitepress/theme/custom.css


[View source]