IORoot.com | IORoot

gatsby

Visit GitHub Repo

IORoot.com Gatsby Version

Latest installation of IORoot.com. Moving from Ghost to Gatsby.

1. Table of Contents

1. Table of Contents
1. About The Project
- 2.1. Built With
- 2.2. Installation
1. Usage
1. Customising
1. Troubleshooting
1. Contributing
1. License
1. Contact
1. Changelog
- 9.1. Version 0.0.1

2. About The Project

IORoot.com is a simple gatsby instance that works with MDX.

It has two sources of data:

The blog repository.
The projects folder within this repository.

The blog repository it built through two methods.

Firstly, there are manually create posted (numbered from 001 onwards). These contitute the blog posts on the homepage.

Secondly, that repository has a github action that scrapes all of my other github repositories for their README.md files. These become all of the projects.

There is a simple frontmatter at the top of each MDX file that is then rendered with the logo/colour of that project.

The logo comes from materialicons and simpleicons.com.

This also uses Tailwind for styling.

Hosted on Netlify.

(back to top)

2.1. Built With

This project was built with the following frameworks, technologies and software.

(back to top)

2.2. Installation

These are the steps to get up and running with this theme.

Clone the repo

git clone ttps://github.com/IORoot/IORoot-Website

NPM Install
```
npm install
```
Run gatsby
```
gatsby develop
```

(back to top)

3. Usage

No usage required.

4. Customising

Edit the theme however you wish.

5. Troubleshooting

This is purely for Parkour Syllabus. No troubleshooting.

(back to top)

6. Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue. Don't forget to give the project a star! Thanks again!

Fork the Project
Create your Feature Branch (git checkout -b feature/AmazingFeature)
Commit your Changes (git commit -m 'Add some AmazingFeature')
Push to the Branch (git push origin feature/AmazingFeature)
Open a Pull Request

(back to top)

7. License

Distributed under the MIT License.

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

(back to top)

8. Contact

Author Link: https://github.com/IORoot

(back to top)

9. Changelog

9.1. Version 1.0.0

Initial Gatsby Release