https://github.com/starfallprojects/tech-writer-toolkit
Resources for consultant and freelance tech writers
https://github.com/starfallprojects/tech-writer-toolkit
Last synced: about 1 year ago
JSON representation
Resources for consultant and freelance tech writers
- Host: GitHub
- URL: https://github.com/starfallprojects/tech-writer-toolkit
- Owner: StarfallProjects
- License: mit
- Created: 2019-05-30T09:32:04.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2021-12-24T16:03:47.000Z (about 4 years ago)
- Last Synced: 2025-02-17T21:52:31.823Z (about 1 year ago)
- Language: HTML
- Homepage: tech-writer-toolkit.vercel.app
- Size: 71.3 KB
- Stars: 17
- Watchers: 5
- Forks: 3
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tech writer toolkit
https://techwritertoolkit.com/
Resources and templates for tech writers.
This site is built with [MkDocs](https://www.mkdocs.org/) and deployed with [Netlify](https://www.netlify.com/). It uses the [mkdocs-material](https://github.com/squidfunk/mkdocs-material) theme.
## Run the site locally
You will need the following installed on your machine:
* [git](https://git-scm.com/downloads)
* [Python](https://www.python.org/) (recommend 3.7)
* Pip (installed with Python from 3.4 onwards)
Clone the repo:
```
git clone https://github.com/StarfallProjects/tech-writer-toolkit.git
```
We strongly recommend using a virtual environment, such as [venv](https://docs.python.org/3/library/venv.html). Make sure to activate your virtual environment before installing the requirements (next step).
Navigate into the top level of the project and run:
```
pip install -r requirements.txt
```
This will install MkDocs, the Material theme, and other dependencies.
Run the project locally with:
```
mkdocs serve
```
## Contribute
> **Note:** for small edits, you can make the changes directly in GitHub. Refer to [this guide](https://www.starfallprojects.co.uk/blog/edit-on-github/) for more informtion. For larger changes (including anything that affects the site styling and layout), follow the steps below.
1. Follow the steps to run the site locally. This allows you to preview your work.
2. Create a new branch. Keep it short but descriptive. If working on an issue, include the issue number.
```
git branch -b
```
3. Make your additions or changes.
4. Check your changes locally.
5. Push your changes to GitHub:
```
git add *
git commit -m "brief description of change, include issue number"
git push --set-upstream origin
```
6. Submit a pull request ([GitHub docs](https://help.github.com/en/articles/creating-a-pull-request#creating-the-pull-request))
7. Request a review from StarfallProjects ([GitHub docs](https://help.github.com/en/articles/requesting-a-pull-request-review))