https://github.com/equilaterus/wikilaterus
Equilaterus' Wiki
https://github.com/equilaterus/wikilaterus
Last synced: 3 days ago
JSON representation
Equilaterus' Wiki
- Host: GitHub
- URL: https://github.com/equilaterus/wikilaterus
- Owner: equilaterus
- License: mit
- Created: 2018-09-24T06:04:21.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-04-12T05:51:39.000Z (almost 3 years ago)
- Last Synced: 2025-10-19T17:33:31.199Z (4 months ago)
- Language: SCSS
- Homepage: https://equilaterus.github.io/wikilaterus/
- Size: 6.16 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Wikilaterus
Equilaterus' Wiki based on [Bootlaterus](https://equilaterus.github.io/bootlaterus/).
Published at: https://equilaterus.github.io/wikilaterus/
## Instructions to run locally
* [Install Ruby](https://equilaterus.github.io/wikilaterus/wiki/Programming-Ruby.html#install-ruby)
* Run the [Powershell](https://equilaterus.github.io/wikilaterus/wiki/Programming-Powershell.html#installation) files on the *util* folder:
* **install-site**: run once to install all requirements to run wikilaterus.
* **run-site**: run to start the server.
* **wiki-sync**: to sync the [wiki](https://github.com/equilaterus/wikilaterus/wiki) with the [githubpages](https://equilaterus.github.io/wikilaterus/) that is deployed through this repo.
* **wiki-add** and **wiki-build**: they're as example to create your own repo synced with a wiki. Run them once just follow the instructions and you'll get a configuration like the one on this repo.
## Wiki to Github Page Plugin
Thanks to djacquel for this: https://github.com/djacquel/WikiToJekyll
## FAQ
* **Where can I store my images?** Add images on the assets folder they'll be published to the Github page automatically.
* **What are the steps to update a wiki?** Always modify your articles directly Github (For example here in our case: https://github.com/equilaterus/wikilaterus/wiki) and then execute *win-wiki-sync.bat*. In case of a desync (that the commands cannot generate the local files), check the next point.
* **wiki got desynced**: this happens because you updated your files locally instead of doing the changes in the Github wiki. You'll need to locate the latest commit that worked correctly and then execute (**PROCEED WITH CAUTION, CREATE A COPY OF YOUR REPO**):
```
git reset --hard
```
And then, to sync with your Github repo (**THIS STEP CAN DAMAGE YOUR ONLINE REPO, PROCEED WITH CAUTION**):
```
git push -f
```
*remote-name* is usually **origin** and *branch name* is usually **master**.
**Note**: these steps are a workarround when there is no way of making work *wiki sync*, use them as a last resource option.
## License
The content of this project itself is licensed under the Creative Commons Attribution 4.0 International ([CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)) license, and the underlying source code used to format and display that content is licensed under the MIT license.