Skip to content

Latest commit

 

History

History
28 lines (22 loc) · 1.27 KB

README.md

File metadata and controls

28 lines (22 loc) · 1.27 KB

V Documentation Generator

NOTE: DO NOT edit the .html files in the main branch of this repository, your changes will be overwritten!

The commits on this repo's main branch are done automatically, each time the main V repo's master branch is updated. The build.vsh script here is responsible for running the generator, and fast.v in the main V repo is responsible for uploading the generated HTML pages to github on each commit.

This repo is responsible for the content on https://docs.vlang.io/ . Its content is generated by a custom V program, that is available in the https://github.com/vlang/docs/tree/generator branch.

The information from https://raw.githubusercontent.com/vlang/v/master/doc/docs.md is split into pages, and each page is formatted to a separate .html file, for the convenience of the viewers.

To change the generator code, do: git clone --branch generator https://github.com/vlang/docs docs_generator/ then follow the instructions in its README.md file.

External dependencies

You'll need rsync, V, and sass .