{"id":19082310,"url":"https://github.com/starfallprojects/tech-writer-toolkit","last_synced_at":"2026-05-23T00:30:23.350Z","repository":{"id":117642574,"uuid":"189385712","full_name":"StarfallProjects/tech-writer-toolkit","owner":"StarfallProjects","description":"Resources for consultant and freelance tech writers","archived":false,"fork":false,"pushed_at":"2021-12-24T16:03:47.000Z","size":73,"stargazers_count":17,"open_issues_count":9,"forks_count":3,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-02-17T21:52:31.823Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"tech-writer-toolkit.vercel.app","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/StarfallProjects.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-05-30T09:32:04.000Z","updated_at":"2021-12-24T16:03:50.000Z","dependencies_parsed_at":null,"dependency_job_id":"d2b9b1dc-0e89-48d6-9fa3-d37c4d4410e6","html_url":"https://github.com/StarfallProjects/tech-writer-toolkit","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StarfallProjects%2Ftech-writer-toolkit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StarfallProjects%2Ftech-writer-toolkit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StarfallProjects%2Ftech-writer-toolkit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StarfallProjects%2Ftech-writer-toolkit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/StarfallProjects","download_url":"https://codeload.github.com/StarfallProjects/tech-writer-toolkit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240131730,"owners_count":19752727,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T02:42:53.780Z","updated_at":"2026-05-23T00:30:23.308Z","avatar_url":"https://github.com/StarfallProjects.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Tech writer toolkit\n\nhttps://techwritertoolkit.com/\n\nResources and templates for tech writers.\n\nThis 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.\n\n\n## Run the site locally\n\nYou will need the following installed on your machine:\n\n* [git](https://git-scm.com/downloads)\n* [Python](https://www.python.org/) (recommend 3.7)\n* Pip (installed with Python from 3.4 onwards)\n\nClone the repo:\n```\ngit clone https://github.com/StarfallProjects/tech-writer-toolkit.git\n```\n\nWe 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).\n\nNavigate into the top level of the project and run:\n\n```\npip install -r requirements.txt\n```\n\nThis will install MkDocs, the Material theme, and other dependencies.\n\nRun the project locally with:\n\n```\nmkdocs serve\n```\n\n## Contribute\n\n\u003e **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.\n\n1. Follow the steps to run the site locally. This allows you to preview your work.\n2. Create a new branch. Keep it short but descriptive. If working on an issue, include the issue number.\n```\ngit branch -b \u003cbranchName\u003e\n```\n3. Make your additions or changes.\n4. Check your changes locally.\n5. Push your changes to GitHub:\n```\ngit add *\ngit commit -m \"brief description of change, include issue number\"\ngit push  --set-upstream origin \u003cbranchName\u003e\n```\n6. Submit a pull request ([GitHub docs](https://help.github.com/en/articles/creating-a-pull-request#creating-the-pull-request))\n7. Request a review from StarfallProjects ([GitHub docs](https://help.github.com/en/articles/requesting-a-pull-request-review))\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstarfallprojects%2Ftech-writer-toolkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstarfallprojects%2Ftech-writer-toolkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstarfallprojects%2Ftech-writer-toolkit/lists"}