Skip to content

Commit 0bcbcc8

Browse files
committed
Merge branch 'master' of https://github.com/blazorhero/docs
2 parents ea9b7ba + 1e8086d commit 0bcbcc8

File tree

2 files changed

+27
-118
lines changed

2 files changed

+27
-118
lines changed

.github/workflows/main.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: github pages
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
pull_request:
8+
9+
jobs:
10+
deploy:
11+
runs-on: ubuntu-18.04
12+
steps:
13+
- uses: actions/checkout@v2
14+
- uses: actions/setup-node@v2
15+
with:
16+
node-version: '14'
17+
- name: Install dependencies
18+
run: npm ci
19+
- name: Delete temporary directories
20+
run: npm run clean
21+
- name: Build production website
22+
run: npm run build
23+
- name: Deploy to GitHub Pages
24+
uses: peaceiris/actions-gh-pages@v3
25+
with:
26+
github_token: ${{ secrets.GT_TOKEN }}
27+
publish_dir: ./public

README.md

Lines changed: 0 additions & 118 deletions
Original file line numberDiff line numberDiff line change
@@ -1,119 +1 @@
1-
<p align="center">
2-
<a href="https://getdoks.org/">
3-
<img alt="Doks" src="https://doks.netlify.app/doks.svg" width="60">
4-
</a>
5-
</p>
61

7-
<h1 align="center">
8-
Doks
9-
</h1>
10-
11-
<h3 align="center">
12-
Modern documentation theme
13-
</h3>
14-
15-
<p align="center">
16-
Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default.
17-
</p>
18-
19-
<p align="center">
20-
<a href="https://github.com/h-enk/doks/blob/master/LICENSE">
21-
<img src="https://img.shields.io/github/license/h-enk/doks?style=flat-square" alt="GitHub">
22-
</a>
23-
<a href="https://github.com/h-enk/doks/releases">
24-
<img src="https://img.shields.io/github/v/release/h-enk/doks?include_prereleases&style=flat-square"alt="GitHub release (latest SemVer including pre-releases)">
25-
</a>
26-
<a href="https://github.com/h-enk/doks/actions?query=workflow%3A%22Hyas+CI%22">
27-
<img src="https://img.shields.io/github/workflow/status/h-enk/doks/Hyas%20CI/master?style=flat-square" alt="GitHub Workflow Status (branch)">
28-
</a>
29-
<a href="https://app.netlify.com/sites/doks/deploys">
30-
<img src="https://img.shields.io/netlify/895a161c-86be-48a2-8c57-a8c5d68cd1a4?style=flat-square" alt="Netlify">
31-
</a>
32-
</p>
33-
34-
![Doks — Modern Documentation Theme](https://raw.githubusercontent.com/h-enk/doks/master/images/tn.png)
35-
36-
## Demo
37-
38-
- [doks.netlify.app](https://doks.netlify.app/)
39-
40-
## Why Doks?
41-
42-
Nine reasons why you should use Doks:
43-
44-
1. __Security aware__. Get A+ scores on [Mozilla Observatory](https://observatory.mozilla.org/analyze/doks.netlify.app) out of the box. Easily change the default Security Headers to suit your needs.
45-
46-
2. __Fast by default__. Get 100 scores on [Google Lighthouse](https://googlechrome.github.io/lighthouse/viewer/?gist=7731347bb8ce999eff7428a8e763b637) by default. Doks removes unused css, prefetches links, and lazy loads images.
47-
48-
3. __SEO-ready__. Use sensible defaults for structured data, open graph, and Twitter cards. Or easily change the SEO settings to your liking.
49-
50-
4. __Development tools__. Code with confidence. Check styles, scripts, and markdown for errors and fix automatically or manually.
51-
52-
5. __Bootstrap framework__. Build robust, flexible, and intuitive websites with Bootstrap 5. Easily customize your Doks site with the source Sass files.
53-
54-
6. __Netlify-ready__. Deploy to Netlify with sensible defaults. Easily use Netlify Functions, Netlify Redirects, and Netlify Headers.
55-
56-
7. __Full text search__. Search your Doks site with FlexSearch. Easily customize index settings and search options to your liking.
57-
58-
8. __Page layouts__. Build pages with a landing page, blog, or documentation layout. Add custom sections and components to suit your needs.
59-
60-
9. __Dark mode__. Switch to a low-light UI with the click of a button. Change colors with variables to match your branding.
61-
62-
## Requirements
63-
64-
Doks uses npm to centralize dependency management, making it [easy to update](https://getdoks.org/docs/help/how-to-update/) resources, build tooling, plugins, and build scripts:
65-
66-
- Download and install [Node.js](https://nodejs.org/) (it includes npm) for your platform.
67-
68-
## Get started
69-
70-
Start a new Doks project in three steps:
71-
72-
### 1. Create a new site
73-
74-
Doks is available as a child theme, and a starter theme:
75-
76-
- Use the Doks child theme, if you do __not__ plan to customize a lot, and/or need future Doks updates.
77-
- Use the Doks starter theme, if you plan to customize a lot, and/or do __not__ need future Doks updates.
78-
79-
Not quite sure? Use the Doks child theme.
80-
81-
#### Doks child theme
82-
83-
```bash
84-
git clone https://github.com/h-enk/doks-child-theme.git my-doks-site && cd my-doks-site
85-
```
86-
87-
#### Doks starter theme
88-
89-
```bash
90-
git clone https://github.com/h-enk/doks.git my-doks-site && cd my-doks-site
91-
```
92-
93-
### 2. Install dependencies
94-
95-
```bash
96-
npm install
97-
```
98-
99-
### 3. Start development server
100-
101-
```bash
102-
npm run start
103-
```
104-
105-
## Other commands
106-
107-
Doks comes with [commands](https://getdoks.org/docs/prologue/commands/) for common tasks.
108-
109-
## Documentation
110-
111-
- [Netlify](https://docs.netlify.com/)
112-
- [Hugo](https://gohugo.io/documentation/)
113-
- [Doks](https://getdoks.org/)
114-
115-
## Communities
116-
117-
- [Netlify Community](https://community.netlify.com/)
118-
- [Hugo Forums](https://discourse.gohugo.io/)
119-
- [Doks Discussions](https://github.com/h-enk/doks/discussions)

0 commit comments

Comments
 (0)