https://github.com/parallaxsecond/parsec-book
Parsec documentation
https://github.com/parallaxsecond/parsec-book
Last synced: 1 day ago
JSON representation
Parsec documentation
- Host: GitHub
- URL: https://github.com/parallaxsecond/parsec-book
- Owner: parallaxsecond
- License: apache-2.0
- Created: 2019-11-13T10:35:01.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T09:40:47.000Z (about 1 year ago)
- Last Synced: 2024-04-08T10:51:22.961Z (about 1 year ago)
- Language: Shell
- Homepage: https://parallaxsecond.github.io/parsec-book
- Size: 16.8 MB
- Stars: 10
- Watchers: 7
- Forks: 17
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# The Parsec Book 📖
This repository is the source code of https://parallaxsecond.github.io/parsec-book
## Using
You can also build the book and read it locally with the following steps:
```bash
$ git clone https://github.com/parallaxsecond/parsec-book.git
$ cd parsec-book
$ cargo install mdbook
$ mdbook serve
```
This book uses the [Versioned Markdown](https://github.com/bobertlo/vmd) format which allows
us to use the `vmdfmt` formatting tool. The lines should be wrapped after 100 characters.
If you have the `vmdfmt` command available on the command-line,
```bash
vmdfmt -cols 100 -w -l src/
```
will format in-place all the markdown files in your current directory, and
```bash
$ ./ci/check_format.sh
```
will check if your files are formatted correctly.
## Contributing
Please check the [**Contribution Guidelines**](https://parallaxsecond.github.io/parsec-book/contributing/index.html)
to know more about the contribution process.
## License
This book is provided under Apache-2.0. Contributions to this project are accepted under the same license.