https://github.com/vlang/docs
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/vlang/docs
- Owner: vlang
- Created: 2024-04-26T09:05:14.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-22T23:11:46.000Z (over 1 year ago)
- Last Synced: 2025-02-23T00:21:58.880Z (over 1 year ago)
- Language: HTML
- Size: 24.2 MB
- Stars: 19
- Watchers: 5
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](./build.vsh) script here is responsible for running
the generator, and
[fast.v in the main V repo](https://github.com/vlang/v/blob/master/cmd/tools/fast/fast.v)
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 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](https://github.com/vlang/docs/blob/generator/README.md) file.
## External dependencies
You'll need `rsync`, [V](https://github.com/vlang/v?tab=readme-ov-file#installing-v-from-source),
and [sass](https://sass-lang.com/install/) .