Midas Touch - GitDoc

Midas Touch - GitDoc is an open-source documentation website hosted on GitHub Pages or potentially gitdoc.org. It's distributed under the MIT license in /License.txt. We pride ourrselves for a FOSS intiative by only using open-sourced libraries or code.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

(Back to Top)

Built With

• Jekyll
• Jekyll Feed
• Jekyll SEO Tag
• Jekyll Sitemap
• Jekyll Watch
• Jekyll SASS Converter
• SASS

(Back to Top)

Getting Started

Use the following instructions to setup the project locally. Linux, Windows, or macOS are the preferred operating systems for these instructions.

Prerequisites

The software required to install the respository are: A terminal, Ruby, and Jekyll. You may also optionally install the SASS compiler if CSS is preferred.

• Terminal install for Linux, Windows, or macOS:

https://git-scm.com/downloads

• Ruby installation for Linux, Windows, or macOS

Check for any existing Ruby versions

ruby -v

If there are none follow these instructions:

https://www.ruby-lang.org/en/documentation/installation

Jekyll installation for Linux, Windows, or macOS (Ruby, Gems, GCC, and MAKE are required)

Install Jekyll via Bundler Gems with Linux, Windows or macOS

gem install jekyll bundler

• SASS installation for Linux, Windows, or macOS

Node.js installation for SASS on any operating system

npm install npm@latest -g

Chocolatey installation for SASS with Windows

choco install sass

Homebrew installation for SASS with Linux or macOS

brew install sass/sass/sass

Troubleshooting

• Visit jekyllrb.com for how to install Jekyll and its dependencies.
• Visit ruby-lang.org for how to install Ruby via command line.
• Visit sass-lang.com for how to install via differing applications.

Installation

1. Follow the Prerequisites

2. Clone the repo via SSH

   git clone git@github.com:MidasTouch-MT/MidasTouch-MT.github.io.git

   Clone the repo via HTTPS

   git clone https://github.com/MidasTouch-MT/MidasTouch-MT.github.io.git

3. Add your site and author details in _config.yml.

4. Install the dependencies with Bundler:

$ bundle install

Run jekyll commands through Bundler to ensure you're using the right versions:

$ bundle exec jekyll serve

5. Midas Touch - GitDoc is already optimised for adding, updating and removing documentation pages in CloudCannon. Add, update or remove a documentation page in the Documentation collection.

• Change the category of a documentation page to move it to another section in the navigation.
• Documentation pages are organised in the navigation by category, with URLs based on the path inside the _docs folder.

6. Edit the Changelog

• Add, update or remove change log entries from your posts.
• Tag entries as minor or major in the front matter.

7. Edit the Search box

• Add excluded_in_search: true to any documentation page's front matter to exclude that page in the search results.

8. Edit the Navigation bar

• Change site.show_full_navigation to control all or only the current navigation group being open.

(Back to Top)

Usage

GitDoc is an automated documentation builder that uses Jekyll to help developers efficiently write documentation for maximum compatability across devices and operating systems. We use embeds, subdomains, and paths to tailor and build documentation configured for each developer's needs. Our team proudly stands with the open-source community to build serious documentation. GitDoc has been tailored for Android, ChromeOS, Linux, iOS, iPadOS, Windows, and macOS.

(Back to Top)

Roadmap

The following are estimates of our timetable:

• [9/1/2022] Automatic Building with UpTimeRobot for Jekyll
• [1/1/2023] Operating System Wide Compatability
• [12/1/2023] Non-profit recognition for our page building system
  • [6/1/2023] Break even point for our project

See the open issues for a full list of proposed features (and known issues).

(Back to Top)

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 with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(Back to Top)

License

Distributed under the MIT License. See LICENSE.txt for more information. README.md is also published under the MIT license, however under a different copyright in /README-LICENSE.txt. /apple-touch-icon.png, /images/favicon.png, /siteicon.png, /images/emblem.svg, /images/_screenshot.png, and touch-icon.png are licensed in /images/MidasTouch_Logo_License.md.

Contact

MidasTouch-MT - midastouch@duck.com

Project Link: https://github.com/MidasTouch-MT/MidasTouch-MT.github.io

(Back to Top)

Acknowledgments

• Othneil Drew for the Best README Template
• CloudCannon for the Edition Jekyll Template
• Shields.io for the README.md headers
• MidasTouch-MT for curating this project with ❤️

(Back to Top)