yaml/docs at main · eemeli/yaml

Name	Name	Last commit message	Last commit date
parent directory ..
01_intro.md	01_intro.md
02_parse_stringify.md	02_parse_stringify.md
03_options.md	03_options.md
04_documents.md	04_documents.md
05_content_nodes.md	05_content_nodes.md
06_custom_tags.md	06_custom_tags.md
07_parsing_yaml.md	07_parsing_yaml.md
08_errors.md	08_errors.md
09_cli.md	09_cli.md
10_yaml_syntax.md	10_yaml_syntax.md
CONTRIBUTING.md	CONTRIBUTING.md
README.md	README.md
SECURITY.md	SECURITY.md
index.html.md	index.html.md
prepare-docs.js	prepare-docs.js

Name

Last commit message

Last commit date

YAML Docs

These documentation source files are compiled into eemeli.org/yaml using a Slate instance that's a git submodule of this repo at docs-slate/.

Modify these source files, noting that sections are defined in index.html.md
Make sure that the Slate submodule is properly initialised. If you've just cloned the repo, the command you'll want is git submodule update --init
Note that docs-slate/source contains symlinks to this folder, which may need extra configuration to work in Windows environments
See docs-slate/README.md for its install instructions
Use npm run docs from this repo's root to preview the site at http://localhost:4567

In addition to the preview steps:

Add this repo as the "yaml" remote for the docs-slate submodule repo: git remote add yaml git@github.com:eemeli/yaml.git
Run the deploy.sh script from the docs-slate folder