Skip to content

Commit f128187

Browse files
Made a README
1 parent d7f739c commit f128187

File tree

2 files changed

+16
-77
lines changed

2 files changed

+16
-77
lines changed

.vscode/launch.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
{
88
"type": "chrome",
99
"request": "launch",
10-
"name": "Launch Edge against localhost",
10+
"name": "Launch Docs",
1111
"url": "http://localhost:1313",
1212
"webRoot": "${workspaceFolder}",
1313
"preLaunchTask": "go-hugo",

README.md

Lines changed: 15 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,83 +1,22 @@
1-
# Hextra Starter Template
1+
# Crash Docs
22

3-
[![Deploy Hugo site to Pages](https://github.com/imfing/hextra-starter-template/actions/workflows/pages.yaml/badge.svg)](https://github.com/imfing/hextra-starter-template/actions/workflows/pages.yaml)
4-
[![Netlify Status](https://api.netlify.com/api/v1/badges/6e83fd88-5ffe-4808-9689-c0f3b100bfe3/deploy-status)](https://app.netlify.com/sites/hextra-starter-template/deploys)
5-
![Vercel Deployment Status](https://img.shields.io/github/deployments/imfing/hextra-starter-template/production?logo=vercel&logoColor=white&label=vercel&labelColor=black&link=https%3A%2F%2Fhextra-starter-template.vercel.app%2F)
3+
Welcome to the Crash Docs.
4+
In an effort to make Crash as easy and transparent as possible for users new and experienced I'm starting to pour my brain out into doc pages.
65

6+
# Helping
77

8-
🐣 Minimal template for getting started with [Hextra](https://github.com/imfing/hextra)
8+
Please open PRs, issues and anything. Even pointing out my terrible spelling is appreciated.
99

10-
![hextra-template](https://github.com/imfing/hextra-starter-template/assets/5097752/c403b9a9-a76c-47a6-8466-513d772ef0b7)
10+
# Building and Debugging
1111

12-
[🌐 Demo ↗](https://imfing.github.io/hextra-starter-template/)
12+
1. Use vscode, you deserve it
13+
2. Run the only available debug option
14+
3. Open localhost:1313 with your browser
15+
4. Marvel
1316

14-
## Quick Start
15-
16-
Use this template to create your own repository:
17-
18-
<img src="https://docs.github.com/assets/cb-77734/mw-1440/images/help/repository/use-this-template-button.webp" width=400 />
19-
20-
You can also quickly start developing using the following online development environment:
21-
22-
- [GitHub Codespaces](https://github.com/codespaces)
23-
24-
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/imfing/hextra-starter-template)
25-
26-
Create a new codespace and follow the [Local Development](#local-development) to launch the preview
27-
28-
- [Gitpod](https://gitpod.io)
29-
30-
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/imfing/hextra-starter-template)
31-
32-
33-
## Deployment
34-
35-
### GitHub Pages
36-
37-
A GitHub Actions workflow is provided in [`.github/workflows/pages.yaml`](./.github/workflows/pages.yaml) to [publish to GitHub Pages](https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/) for free.
38-
39-
For details, see [Publishing with a custom GitHub Actions workflow](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow).
40-
41-
Note: in the settings, make sure to set the Pages deployment source to **GitHub Actions**:
42-
43-
<img src="https://github.com/imfing/hextra-starter-template/assets/5097752/99676430-884e-42ab-b901-f6534a0d6eee" width=600 />
44-
45-
[Run the workflow manually](https://docs.github.com/en/actions/using-workflows/manually-running-a-workflow) if it's not triggered automatically.
46-
47-
### Netlify
48-
49-
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/imfing/hextra-starter-template)
50-
51-
### Vercel
52-
53-
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fimfing%2Fhextra-starter-template&env=HUGO_VERSION)
54-
55-
Override the configuration:
56-
57-
<img src="https://github.com/imfing/hextra-starter-template/assets/5097752/e2e3cecd-c884-47ec-b064-14f896fee08d" width=600 />
58-
59-
## Local Development
60-
61-
Pre-requisites: [Hugo](https://gohugo.io/getting-started/installing/), [Go](https://golang.org/doc/install) and [Git](https://git-scm.com)
62-
63-
```shell
64-
# Clone the repo
65-
git clone https://github.com/imfing/hextra-starter-template.git
66-
67-
# Change directory
68-
cd hextra-starter-template
69-
70-
# Start the server
71-
hugo mod tidy
72-
hugo server --logLevel debug --disableFastRender -p 1313
73-
```
74-
75-
### Update theme
76-
77-
```shell
78-
hugo mod get -u
79-
hugo mod tidy
80-
```
81-
82-
See [Update modules](https://gohugo.io/hugo-modules/use-modules/#update-modules) for more details.
17+
# Editing
8318

19+
This site is written using Hugo and served with GitHub Pages.
20+
Hugo is pretty easy, and it uses Hextra as the theme.
21+
[Hugo Docs](https://gohugo.io/documentation/)
22+
[Hextra Docs](https://imfing.github.io/hextra/docs/)

0 commit comments

Comments
 (0)