https://github.com/rathena/user-guides

A collection of user-submitted guides in markdown format, for both easy-reading and for automated generation via mkdocs.
https://github.com/rathena/user-guides

documentation hacktoberfest rathena

Last synced: 7 months ago
JSON representation

A collection of user-submitted guides in markdown format, for both easy-reading and for automated generation via mkdocs.

• Host: GitHub
• URL: https://github.com/rathena/user-guides
• Owner: rathena
• Created: 2023-04-03T07:16:15.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2024-09-18T12:41:03.000Z (almost 2 years ago)
• Last Synced: 2024-12-28T16:44:06.415Z (over 1 year ago)
• Topics: documentation, hacktoberfest, rathena
• Language: Dockerfile
• Homepage: https://rathena.github.io/user-guides/
• Size: 415 KB
• Stars: 10
• Watchers: 13
• Forks: 10
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
[![GitHub](https://img.shields.io/github/license/rathena/rathena?style=for-the-badge)](https://github.com/rathena/rathena/blob/master/LICENSE) 

[![GitHub last commit](https://img.shields.io/github/last-commit/rathena/user-guides?label=updated&style=for-the-badge)](https://github.com/rathena/user-guides/commits/master) 

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/rathena/user-guides/deploy_guides.yml?label=automatic%20building&style=for-the-badge)](https://github.com/rathena/user-guides/actions) 

![GitHub pull requests](https://img.shields.io/github/issues-pr-raw/rathena/user-guides?label=Open%20PR&style=for-the-badge)

# Welcome to User-Guides

A collection of user-submitted guides in markdown format, for both easy-reading and for automated generation via mkdocs.

The files inside `/guides/` are automatically generated by some fantastic software called MkDocs. MkDocs is a static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.

Each time a commit is pushed to the master branch, the site is automatically rebuilt and deployed to GitHub Pages by a Github Action. You can view the generated site at [https://rathena.github.io/user-guides/](https://rathena.github.io/user-guides/).

## Contributing

If you would like to contribute to this project, please read the [Contributing Guide](CONTRIBUTING.md).

## Development

You can use the included dockerfile to create a docker container for development. Run the following commands in the root directory of the project (where this file is).

### Build the container

`docker build -f docker/Dockerfile -t ra-user-guides .`

This uses the same base image as the github actions, then installs the extra packages in `.github/requirements.txt`. You only need to do this once, or every time the list of requirements change.

### Run the container

`docker run --rm -it -p 8000:8000 -v ${PWD}:/docs ra-user-guides`

This runs the container we made in step one, mounts our current directory to `/docs` in the container, and opens the `8000` port. This will watch for changes as we make them. You can see the changes in your browser by going to `localhost:8000/user-guides`

## License

This project is licensed under the same terms as rAthena's [Source Code](https://github.com/rathena/rathena) - see the [LICENSE](https://github.com/rathena/rathena/blob/master/LICENSE) file for details.