Skip to content

Commit

Permalink
doc: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
katallaxie authored Dec 4, 2024
1 parent 94d0fff commit ad89a22
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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**.

Expand Down

0 comments on commit ad89a22

Please sign in to comment.