https://github.com/korlibs/docs.korge.org
https://github.com/korlibs/docs.korge.org
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/korlibs/docs.korge.org
- Owner: korlibs
- License: mit
- Created: 2023-12-01T13:01:08.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-28T15:03:32.000Z (almost 2 years ago)
- Last Synced: 2024-12-28T18:03:03.199Z (over 1 year ago)
- Language: CSS
- Size: 9.28 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 54
-
Metadata Files:
- Readme: README.md
- Changelog: newsearch.css
- License: LICENSE
- Roadmap: roadmap/ideas.canvas
Awesome Lists containing this project
README
# docs.korge.org
This is the offical documentation of the framework Korlibs.
Contributions in every way are welcome.
You can edit the documentation with:
* [https://marketplace.visualstudio.com/items?itemName=cweijan.vscode-office](https://marketplace.visualstudio.com/items?itemName=cweijan.vscode-office)
* [https://obsidian.md/](%E2%80%B8https://obsidian.md/)
To launch the documentation locally on your PC there are 2 options:
## Option 1: [Install jekyll](https://jekyllrb.com/docs/installation/)
Then execute `jekyll s`
## Option 2: [install docker](https://docs.docker.com/get-docker/)
Then execute `./jekyll.sh` on linux or `jekyll2.bat` on Windows
## Advices
To simplify image illustration and editing. I recommend:
* Snagit - Configured with `cmd+shift+2` on MacOS
* After creating and editing, you can press `cmd+c` to copy and use the Paste Images into Markdown plugin to create an image
* Webstorm
* [Paste Images into Markdown Webstorm plugin](https://github.com/holgerbrandl/pasteimages)