Quickstart with github pages
-
Either name your fork
<github-username>.github.io
if you want your blog to live at<github-username>.github.io
-
Or choose any other repo name and it will live at
<github-username>.github.io/<repo-name>
-
In your repository settings, set up github pages to deploy using github actions (SETTINGS -> PAGES -> SOURCE: Github Actions)
-
Set up your blog info in
src/config.ts
, most importantly theSITE
andBASE
variables:
SITE
: set tohttps://<github-username>.github.io
BASE
: if repo name is<github-username>.github.io
set to/
, otherwise set to/<repo-name>
-
Once you push your changes to main your blog should be live in about 1-2 minutes at
<github-username>.github.io
or<github-username>.github.io/<repo-name>
-
Set up more info in
src/config.ts
(see all options here)
SITE_TITLE
is the title of your blog, and will be shown in the header and in search resultsSITE_DESCRIPTION
is the description of your blog, and will be shown e.g. in search resultsSITE_FAVICON
is the emoji that will be shown as favicon of your blog (will be shown in the header and as favicon)NAME
is the name of the author of the blog, will be shown in the footer as(c) <YEAR> <NAME> - LICENSE
BLUESKY_IDENTIFIER
is your bluesky handle (without the@
), this is needed for likes and comments to work (see comments via bluesky)SOCIAL_LINKS
set your social media links here, e.g.{ BLUESKY_URL: "https://bsky.app/profile/flo-bit.dev" }
will be shown in the footer of the blog
-
Edit
about.mdx
insrc/content/info/
to add your own about page. -
Remove all files from
src/content/blog/
and add your own blog posts there. Time to write your first blog post! (see adding content for more info) -
Anytime you push to the main branch, your blog will automatically be updated (should usually take less than 2 minutes). You can also go to the github actions tab to check the progress/status.
If you run into any issues, feel free to open an issue or contact me on bluesky