Skip to content

Commit

Permalink
Create docsify site (#199)
Browse files Browse the repository at this point in the history
## Description

This PR adds a [docsify](https://docsify.js.org/#/) index file so that `codeowners-generator` users have a nicer experience working through the documentation.

The toplevel README is the single source of truth for docsify, so a change to the README will cause the docsify site to automatically update.
  • Loading branch information
cyamonide authored Feb 1, 2021
1 parent 357e02e commit b1d8e69
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 2 deletions.
Empty file added .nojekyll
Empty file.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@

<h3 align="center">codeowners-generator</h3>
<p align="center">
<a href="https://github.com/gagoar/use-herald-action">
<a href="https://gagoar.github.io/codeowners-generator/">
<img src="images/logo.png" alt="Logo" width="128" height="128">
</a>
</p>
<p align="center">
✨ use codeowners anywhere in your monorepo 🛠️
<br />
<a href="https://github.com/gagoar/codeowners-generator#table-of-contents"><strong>Explore the docs »</strong></a>
<a href="https://gagoar.github.io/codeowners-generator/"><strong>Explore the docs »</strong></a>
<br />
<a href="https://github.com/gagoar/codeowners-generator/issues">Report Bug</a>
·
Expand Down
22 changes: 22 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Documentation | codeowners-generator</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="description" content="Documentation for codeowners-generator - use codeowners anywhere in your monorepo!">
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
</head>
<body>
<div id="app"></div>
<script>
window.$docsify = {
name: '',
repo: ''
}
</script>
<!-- Docsify v4 -->
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
</body>
</html>

0 comments on commit b1d8e69

Please sign in to comment.