mirror of
https://github.com/apricote/releaser-pleaser.git
synced 2026-01-13 13:21:00 +00:00
docs: setup mdbook (#27)
This commit is contained in:
parent
3e51dd8495
commit
a67b510284
13 changed files with 90 additions and 0 deletions
1
docs/.gitignore
vendored
Normal file
1
docs/.gitignore
vendored
Normal file
|
|
@ -0,0 +1 @@
|
|||
book
|
||||
28
docs/SUMMARY.md
Normal file
28
docs/SUMMARY.md
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
# Summary
|
||||
|
||||
[Introduction](introduction.md)
|
||||
|
||||
# Tutorials
|
||||
|
||||
- [Getting started on GitHub](tutorials/github.md)
|
||||
- [Getting started on GitLab]()
|
||||
|
||||
# Explanation
|
||||
|
||||
- [Release Pull Request](explanation/release-pr.md)
|
||||
|
||||
# Guides
|
||||
|
||||
- [Customizing Release Notes](guides/release-notes.md)
|
||||
- [Pre-releases](guides/pre-releases.md)
|
||||
- [Workflow Permissions on GitHub](guides/github-workflow-permissions.md)
|
||||
|
||||
# Reference
|
||||
|
||||
- [Pull Request Options](reference/pr-options.md)
|
||||
- [GitHub Action](reference/github-action.md)
|
||||
- [GitLab CI]()
|
||||
|
||||
---
|
||||
|
||||
[Changelog](changelog.md)
|
||||
8
docs/book.toml
Normal file
8
docs/book.toml
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
[book]
|
||||
language = "en"
|
||||
multilingual = false
|
||||
src = "."
|
||||
title = "releaser-pleaser"
|
||||
|
||||
[build]
|
||||
build-dir = "book"
|
||||
3
docs/changelog.md
Normal file
3
docs/changelog.md
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
# Changelog
|
||||
|
||||
{{#include ../CHANGELOG.md:2: }}
|
||||
1
docs/explanation/release-pr.md
Normal file
1
docs/explanation/release-pr.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
# Release Pull Request
|
||||
1
docs/guides/github-workflow-permissions.md
Normal file
1
docs/guides/github-workflow-permissions.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
# Workflow Permissions on GitHub
|
||||
1
docs/guides/pre-releases.md
Normal file
1
docs/guides/pre-releases.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
# Pre-releases
|
||||
1
docs/guides/release-notes.md
Normal file
1
docs/guides/release-notes.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
# Customizing Release Notes
|
||||
3
docs/introduction.md
Normal file
3
docs/introduction.md
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
# Introduction
|
||||
|
||||
{{#include ../README.md:2:}}
|
||||
1
docs/reference/github-action.md
Normal file
1
docs/reference/github-action.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
# GitHub Action
|
||||
1
docs/reference/pr-options.md
Normal file
1
docs/reference/pr-options.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
# Pull Request Options
|
||||
1
docs/tutorials/github.md
Normal file
1
docs/tutorials/github.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
# GitHub
|
||||
Loading…
Add table
Add a link
Reference in a new issue