https://github.com/codethesaurus/docs

The documentation for all things Code Thesaurus!
https://github.com/codethesaurus/docs

hacktoberfest hacktoberfest2020 hacktoberfest2021 hacktoberfest2022 mkdocs programming-languages

Last synced: 3 months ago
JSON representation

The documentation for all things Code Thesaurus!

• Host: GitHub
• URL: https://github.com/codethesaurus/docs
• Owner: codethesaurus
• License: agpl-3.0
• Created: 2020-10-22T03:16:02.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-11-23T02:14:53.000Z (about 2 years ago)
• Last Synced: 2023-03-08T19:06:48.264Z (almost 2 years ago)
• Topics: hacktoberfest, hacktoberfest2020, hacktoberfest2021, hacktoberfest2022, mkdocs, programming-languages
• Language: Dockerfile
• Homepage: https://docs.codethesaur.us
• Size: 107 KB
• Stars: 7
• Watchers: 3
• Forks: 14
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing.md
  • License: LICENSE
  • Code of conduct: docs/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Welcome to the Code Thesaurus documentation!

## What is Code Thesaurus?

It is a polyglot developer reference tool originally created to help you compare a language you know with one you don't. The main purpose is to be a quick and easy reference tool to help people that use a lot of programming languages and have to context switch a lot. It also allows you to pick up how to use a new programming language fast without needing to read documentation.

## What is this repository?

This is the collection of documentation for Code Thesaurus, located at [docs.codethesaur.us](https://docs.codethesaur.us).

Learn more by reading over the [project details](https://docs.codethesaur.us/about/) on the docs themselves!

## How do I install and run this repo? 

You can find the directions to [run with Docker](https://docs.codethesaur.us/install/install-docs-docker) or to [run manually](https://docs.codethesaur.us/install/install-docs-manual) on the docs site.

## Is this project available for Hacktoberfest contributions?

Yes! The Code Thesaurus code and documentation projects are both enabled for Hacktoberfest contributions.

## How can I help?

This project values open source contributors, both to the main project and to the documentation! We'd love to have your help.

* Start with our [Contribution Guidelines](#)

* Look through [the repo](https://github.com/codethesaurus/docs/issues/) for issues or bugs 

* Add any missing information on the main site

* Correct any incorrect information on the main site or the documentation

* Help think through the future of what Code Thesaurus could be

* Find more developers of any experience level and background to help contribute!