diff --git a/README.md b/README.md index 86cfdfc..4edc74d 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,18 @@ -# Docs Template +# 📝 Docs Template A teeny tiny template to start a documentation. -## Deploy +## Customize It defaults to deploy to [GitHub Pages](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site) -1. Fork [ZEISS/docs-template](https://github.com/ZEISS/docs-template) +This is a [template repository](https://docs.github.com/de/repositories/creating-and-managing-repositories/creating-a-template-repository) -2. Set `BASE_PATH` in `.github/workflows/pages.yml` as your repository name +1. Use the `Use this template` button to create a new repository. -3. Go to **Settings** --> **Pages** +2. Set `BASE_PATH` in `.github/workflows/pages.yml` as your repository name. + +3. Go to **Settings** 👉 **Pages** in your repository. 4. Select **GitHub Actions** in **Build and deployment**.