flo-bit.dev
[READ-ONLY] Mirror of https://github.com/flo-bit/blog-template. minimalistic astro blog template
flo-bit.dev/blog-template/
astro
blog
template
update instructions
author
Florian
date
(Oct 26, 2024, 11:20 PM +0200)
commit
80993eb0
80993eb03c3d4e7eda94502933821eeb1e93975e
parent
e22188b7
e22188b775083a2f37b2f95edc2bfc9db9bd57f8
+50
-17
+6
-1
.github/workflows/deploy.yml
+6
-1
.github/workflows/deploy.yml
···
21
21
run: |
22
22
if jq '.MANUAL_SITE_BASE == false' src/config.json; then
23
23
SITE="https://$GITHUB_ACTOR.github.io"
24
-
BASE="/${GITHUB_REPOSITORY#*/}"
24
+
REPO_NAME="${GITHUB_REPOSITORY#*/}"
25
+
if [ "$REPO_NAME" = "$GITHUB_ACTOR.github.io" ]; then
26
+
BASE=""
27
+
else
28
+
BASE="/$REPO_NAME"
29
+
fi
25
30
jq --arg SITE "$SITE" --arg BASE "$BASE" \
26
31
'.SITE = $SITE | .BASE = $BASE' src/config.json > tmp.$$.json && mv tmp.$$.json src/config.json
27
32
fi
+22
-8
README.md
+22
-8
README.md
···
31
31
32
32
## Minimal setup with github pages
33
33
34
-
1. Fork this repository
34
+
1. Fork this repository.
35
35
36
-
2. Set up your blog info in `src/config.json` (most importantly set 'SITE' and 'BASE' to your corresponding values, see [configuring your site](https://flo-bit.dev/blog-template/posts/configuring-the-blog))
36
+
2. In your repository settings, set up github pages to deploy using github actions (*SETTINGS* -> *PAGES* -> *SOURCE*: **Github Actions**)
37
37
38
-
3. Add your blog posts in `src/content/blog/`
38
+
3. Your blog should be live in about 1 minute at `https://<your-github-username>.github.io/<your-repo-name>`
39
39
40
-
4. Add your info in `src/content/info/`:
40
+
For editing the blog you can either edit the code directly or use the preconfigured [pagescms](https://next.pagescms.org).
41
41
42
-
- `description.md` is used for the homepage description
43
-
- `about.md` is used for the about page
42
+
### Editing with pagescms
44
43
45
-
5. In your repository settings, set up github pages to deploy using github actions
44
+
4. Go to [pagescms](https://next.pagescms.org) and log in with your github account and authorize the app.
46
45
47
-
6. Enjoy your new blog at: `https://<your-github-username>.github.io/<your-repo-name>`
46
+
5. Add your repository to pagescms and open it.
47
+
48
+
6. Now you can edit your website configuration, about page, description and blog posts directly in the browser.
49
+
50
+
7. Your changes will be automatically pushed to your repository and deployed to github pages in about 1 minute everytime you hit save.
51
+
52
+
### Editing the code
53
+
54
+
4. Set up your blog info in `src/config.json` (leaving SITE, BASE, and MANUAL_SITE_BASE, as they are).
55
+
56
+
5. Add your blog posts in `src/content/blog/`
57
+
58
+
6. Add your info in `src/content/info/`:
59
+
60
+
- `description.md` is used for the homepage description
61
+
- `about.md` is used for the about page
+20
-8
src/content/blog/how-to-use.md
+20
-8
src/content/blog/how-to-use.md
···
9
9
10
10
1. Fork [the repository of this blog](https://github.com/flo-bit/blog-template)
11
11
12
-
2. Set up your blog info in `src/config.json` (most importantly set `SITE` and `BASE` to your corresponding values, see [`src/consts.ts`](../const-ts) for more info)
12
+
2. In your repository settings, set up github pages to deploy using github actions (*SETTINGS* -> *PAGES* -> *SOURCE*: **Github Actions**)
13
13
14
-
3. Add your blog posts in `src/content/blog/` (see [adding content](../adding-content) for more info)
14
+
3. Your blog should be live in about 1 minute at `https://<your-github-username>.github.io/<your-repo-name>`
15
15
16
-
4. Add your info in `src/content/info/`:
16
+
For editing the blog you can either edit the code directly or use the preconfigured [pagescms](https://next.pagescms.org).
17
17
18
-
- `description.md` is used for the homepage description
19
-
- `about.md` is used for the about page
18
+
### Editing with pagescms
20
19
21
-
5. In your repository settings, set up github pages to deploy using github actions
20
+
4. Go to [pagescms](https://next.pagescms.org) and log in with your github account and authorize the app.
22
21
23
-
6. Enjoy your new blog at: `https://<your-github-username>.github.io/<your-repo-name>`
22
+
5. Add your repository to pagescms and open it.
24
23
25
-
For more information on how you can add content see the post about [adding content](../adding-content) or read about [supported markdown features here](../markdown-style-guide).
24
+
6. Now you can edit your website configuration, about page, description and blog posts directly in the browser.
25
+
26
+
7. Your changes will be automatically pushed to your repository and deployed to github pages in about 1 minute everytime you hit save.
27
+
28
+
### Editing the code
29
+
30
+
4. Set up your blog info in `src/config.json` (leaving SITE, BASE, and MANUAL_SITE_BASE, as they are).
31
+
32
+
5. Add your blog posts in `src/content/blog/`
33
+
34
+
6. Add your info in `src/content/info/`:
35
+
36
+
- `description.md` is used for the homepage description
37
+
- `about.md` is used for the about page
+2
src/content/info/description.md
+2
src/content/info/description.md
···
1
1
# Blog template
2
2
3
+
> This description will be shown on the main page of your blog above your most recent posts. It could be a short summary of what your blog is about, and what readers can expect.
4
+
3
5
Minimalistic but opinionated blog template using [astro](https://astro.build/) and [svelte](https://svelte.dev/). aims to be super easy to deploy and use, with a focus on performance and SEO, ease-of-use and design (see all [features here](posts/features)).
4
6
5
7
This blog doubles as a tutorial on how to use this template, start by [setting up your github repo](posts/how-to-use), then [add some content](posts/adding-content). For more information read about [supported markdown features here](posts/markdown-style-guide).