From fab5b8195b458503ac909b52d4b73a3491a7821c Mon Sep 17 00:00:00 2001 From: Tommy Poll Date: Fri, 26 Apr 2024 03:55:12 +0100 Subject: [PATCH] Remove Netlify for good --- README.md | 13 ++++++++++--- pyproject.toml | 2 +- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 465eef7..fad5bf0 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,15 @@ # SRO Knowledgebase -This is the SRO Knowledgebase, which can be [viewed here](https://sro.netlify.com). +This is the SRO Knowledgebase, which can be [viewed here](https://kb.roboticsoutreach.org). It is built using [Mkdocs](https://www.mkdocs.org/) and should be as easy as writing Markdown. -It is published automagically using Netlify. -When you push changes and create a pull request, Netlify will create a preview version of the site accessible with a link from the pull request page. +It is published automagically using GitHub Actions and GitHub Pages. + +Want to build your own copy of the knowledgebase? Clone the repository and run this: + +```bash +pip install -r requirements.txt +mkdocs build +mkdocs serve +``` diff --git a/pyproject.toml b/pyproject.toml index 767f2b2..e20c0d4 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -2,7 +2,7 @@ name = "kb" version = "0.1.0" description = "" -authors = ["Dan Trickey "] +authors = ["Southampton Robotics Outreach ", "Dan Trickey "] [tool.poetry.dependencies] python = "^3.7"