Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vala-lang/vala-docs
Vala Documentation Website
https://github.com/vala-lang/vala-docs
docs documentation hacktoberfest markdown sphinx vala website
Last synced: about 1 month ago
JSON representation
Vala Documentation Website
- Host: GitHub
- URL: https://github.com/vala-lang/vala-docs
- Owner: vala-lang
- License: cc-by-sa-4.0
- Created: 2024-04-01T20:47:27.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-11-10T00:57:07.000Z (about 1 month ago)
- Last Synced: 2024-11-10T01:31:46.111Z (about 1 month ago)
- Topics: docs, documentation, hacktoberfest, markdown, sphinx, vala, website
- Language: CSS
- Homepage: https://docs.vala.dev/
- Size: 8.04 MB
- Stars: 1
- Watchers: 2
- Forks: 8
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Vala Documentation
This is the source code repository for the Vala Documentation website.
You can view the website online here: https://docs.vala.dev/
Also, you can contribute to the Vala programming language website here: https://github.com/vala-lang/vala-www
## Requirements
- python3
- pip (for Python 3)
You'll also need to install Sphinx and other dependencies listed in the `requirements.txt` file:
```sh
pip install --user --upgrade -r requirements.txt
```
## Getting started
1. Build the website with:
```sh
./build-docs
```
Note: You may need to make the `./build-docs` script executable first:
```sh
chmod +x ./build-docs
```
2. In the `build` directory, open a html file in your favourite web browser. `index.html` contains the home page.
3. Whenever you want to rebuild the site with changes you make in `source`, repeat step 1.
## References
- [Sphinx Documentation](https://www.sphinx-doc.org/en/master/contents.html)
- [Furo Theme](https://github.com/pradyunsg/furo)
- [reStructuredText (The format that this tutorial is written in.)](https://www.writethedocs.org/guide/writing/reStructuredText/)
- [Google Technical Writing Resources](https://developers.google.com/tech-writing)