{"id":18736179,"url":"https://github.com/rathena/user-guides","last_synced_at":"2025-11-16T14:30:18.012Z","repository":{"id":151133944,"uuid":"622843004","full_name":"rathena/user-guides","owner":"rathena","description":"A collection of user-submitted guides in markdown format, for both easy-reading and for automated generation via mkdocs.","archived":false,"fork":false,"pushed_at":"2024-09-18T12:41:03.000Z","size":425,"stargazers_count":10,"open_issues_count":1,"forks_count":10,"subscribers_count":13,"default_branch":"master","last_synced_at":"2024-12-28T16:44:06.415Z","etag":null,"topics":["documentation","hacktoberfest","rathena"],"latest_commit_sha":null,"homepage":"https://rathena.github.io/user-guides/","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rathena.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-04-03T07:16:15.000Z","updated_at":"2024-09-18T12:29:30.000Z","dependencies_parsed_at":"2024-01-13T00:58:21.303Z","dependency_job_id":null,"html_url":"https://github.com/rathena/user-guides","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rathena%2Fuser-guides","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rathena%2Fuser-guides/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rathena%2Fuser-guides/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rathena%2Fuser-guides/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rathena","download_url":"https://codeload.github.com/rathena/user-guides/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239611993,"owners_count":19668274,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","hacktoberfest","rathena"],"created_at":"2024-11-07T15:19:36.122Z","updated_at":"2025-11-16T14:30:17.895Z","avatar_url":"https://github.com/rathena.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![GitHub](https://img.shields.io/github/license/rathena/rathena?style=for-the-badge)](https://github.com/rathena/rathena/blob/master/LICENSE) \n[![GitHub last commit](https://img.shields.io/github/last-commit/rathena/user-guides?label=updated\u0026style=for-the-badge)](https://github.com/rathena/user-guides/commits/master) \n[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/rathena/user-guides/deploy_guides.yml?label=automatic%20building\u0026style=for-the-badge)](https://github.com/rathena/user-guides/actions) \n![GitHub pull requests](https://img.shields.io/github/issues-pr-raw/rathena/user-guides?label=Open%20PR\u0026style=for-the-badge)\n\n# Welcome to User-Guides\nA collection of user-submitted guides in markdown format, for both easy-reading and for automated generation via mkdocs.\n\nThe 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.\n\nEach 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/).\n\n## Contributing\nIf you would like to contribute to this project, please read the [Contributing Guide](CONTRIBUTING.md).\n\n## Development\nYou 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).\n\n### Build the container\n\n`docker build -f docker/Dockerfile -t ra-user-guides .`\n\nThis 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.\n\n### Run the container\n\n`docker run --rm -it -p 8000:8000 -v ${PWD}:/docs ra-user-guides`\n\nThis 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`\n\n## License\nThis 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.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frathena%2Fuser-guides","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frathena%2Fuser-guides","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frathena%2Fuser-guides/lists"}