https://github.com/sentenza/docs
Useful resources about Scala and FP
https://github.com/sentenza/docs
docs functional-programming scala
Last synced: 9 months ago
JSON representation
Useful resources about Scala and FP
- Host: GitHub
- URL: https://github.com/sentenza/docs
- Owner: sentenza
- License: gpl-3.0
- Created: 2018-10-23T18:11:25.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-08-02T10:07:40.000Z (over 2 years ago)
- Last Synced: 2025-01-14T13:14:14.309Z (10 months ago)
- Topics: docs, functional-programming, scala
- Language: HTML
- Homepage: http://torre.me.uk/docs
- Size: 1.98 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Useful documentation
After a lot of thinking, following the example of [@niqdev][niqdev], I've decided to create this project to collect all the useful information about what I like most: **programming**.
[niqdev]: https://github.com/niqdev/devops
# Install mkdocs locally
```sh
python3 -m pip install -r requirements.txt
python3.11 -m pip install mkdocs-material
```
### How to serve, build and deploy
To start the dev server:
```sh
$ mkdocs serve
INFO - Building documentation...
INFO - Cleaning site directory
[I 160402 15:50:43 server:271] Serving on http://127.0.0.1:8000
[I 160402 15:50:43 handlers:58] Start watching changes
[I 160402 15:50:43 handlers:60] Start detecting changes
````
In order to build the website:
```sh
mkdocs build
```
This will create a new directory, named `site`.
To deploy the website to GH pages:
```sh
mkdocs gh-deploy
```
#### Customization
[Material Theme](https://squidfunk.github.io/mkdocs-material)