Notes Website Setup
Technology
Section titled TechnologyThese notes are powered by Astro, Starlight, and the Starlight Obsidian plugin. The website is hosted for free on Vercel.
Getting Started
Section titled Getting StartedTo build a website just like this, check out: Starlight Obsidian’s Getting Started documentation.
Adjustments
Section titled AdjustmentsPlugins
Section titled PluginsSee the plugin list. Some highlights:
- https://github.com/HiDeoo/starlight-links-validator
- https://github.com/HiDeoo/starlight-image-zoom
- https://github.com/HiDeoo/starlight-heading-badges
Landing page
Section titled Landing pageYou can replace the default landing page of the notes website (at the root /
) with a note, as I have done.
- Change
src/content/docs/index.mdx
tosrc/content/docs/index.md
(.mdx
to.md
). - Then adjust the front matter of that file as shown below (set
template: doc
).
Show lastUpdated
Section titled Show lastUpdatedYou can display and track the date on which a note was last updated. This uses markdown front matter.
- Set the Starlight property
lastUpdated
totrue
. - Set the Starlight Obsidian property
copyFrontmatter
to'starlight'
. - Now in your notes
- Adjust the
lastUpdated
property in the note’s front matter manually; - Or, use an Obsidian plugin such as obsidian-frontmatter-modified-date to automatically update this property as your edit your notes (src). Configure this plugin to set the
lastUpdated
property and use the following date formatYYYY-MM-DD
.
- Adjust the
Callouts
Section titled CalloutsFor callouts (warnings, info blocks) see Markdown#Callouts.
Link Headings
Section titled Link HeadingsSet the Starlight Obsidian property autoLinkHeadings
to true
.
Theme
Section titled ThemeAdjust the website’s theme with custom CSS styles. There is a live editor.
Site Search
Section titled Site SearchSource. Note that site search is built-in under Cmd + K
.