Skip to content

andersthemagi/magicalmusings.github.io

Repository files navigation

Magical Musings

Status Last Commit Issues Open Issues Closed Repo Size

Hacktoberfest Contributors Contributor Covenant License

A simple blog-style website to detail ramblings on Dungeons and Dragon's 5th Edition. You can see the live site at https://magicalmusings.github.io/.

Pull Requests and Contributions

Feedback and contributions are more than welcome on this project! All contributors are expected to be following the Contributor Covenant. You can find information on what that entails in the code_of_conduct.md file located in the main directory.

In general, I follow the "fork-and-pull" Git workflow.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

Building the Website on Local Machines

See the Jekyll Quick Start guide for more detailed steps on how to build sites locally.

Instructions

  1. Install all prerequisites
  2. Install the jekyll and bundler gems
gem install jekyll bundler
  1. Build the site in the main directory and make it available on a local server. The --livereload option makes it so Jekyll automatically refreshes the page with each change you make to the source files.
bundle exec jekyll serve --livereload
  1. Navigate to https://localhost:4000

It's that simple! If you encounter any errors during this process, check that you have installed all the prerequisites in Requirements. If you still have issues, see Troubleshooting.

Issues / Feature Requests

In the event you find any bugs / typos, or want to suggest adding information or content to the site, feel free to open up an issue on the Issue Tracker detailing everything you want me to know. For my D&D Players, there may be in-game incentive on the line if you help me out this way!!

License and Credits

The theme is available as open source under the terms of the MIT License. Jekyll Theme Leaf is a very simple yet beautiful theme created by Supun Kavinda. It is designed for those who love dark sites.

All content on this website is either mine or attributed to the author / content creators with sources. When possible, I will indicate any licensing or permissions regarding the information on the given page for said content. Official Dungeons and Dragons 5th Edition Rules are provided through the 5th Edition System Reference Document (5e SRD) by Wizards of the Coast under the OGL 1.0a.

Please contact Andres Sepulveda at magical.musings2020@gmail.com with any questions or concerns regarding any issues of this manner.