Skip to content

Commit

Permalink
Improve documentation for FAQ.
Browse files Browse the repository at this point in the history
- Add an id to the FAQ list to allow linking to specific questions.
- Remove file added in error.
- Improve dark mode icon documentation.
  • Loading branch information
manugarg committed Nov 26, 2024
1 parent d2dd25b commit 0d6e6e7
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 26 deletions.
5 changes: 3 additions & 2 deletions docs/content/faq/dark_mode_icon.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@ date: 2022-04-09T09:41:34-07:00
draft: false
weight: 1
---
There are three options for the 'Use dark mode icons' setting in the extension options page:
Extension will automatically switch to dark mode icons if you change OS settings to dark mode. You can change this behavior by changing the 'Use dark mode icons' setting:

- Auto (default)
- Automatically choose between dark and light mode icons based on the OS settings. Note that browser level setting doesn't trigger this change.
- Automatically choose between dark and light mode icons based on the OS settings. Note that browser level theme change doesn't trigger this change.
- Always
- Always use dark mode icons.
- Never
Expand Down
10 changes: 4 additions & 6 deletions docs/content/faq/site_level.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
---
title: 'What are site level notes?'
---
title: 'What Are Site-Level Notes?'
date: 2022-04-09T09:41:34-07:00
draft: false
weight: 2
---

Site-level notes are applied to all pages with the same hostname. For example, if you add
a site-level note for `github.com`, those notes will apply to all pages on github.com,
including e.g. `https://github.com/manugarg/pagenotes-issues`.
Site-level notes are applied to all pages with the same hostname. For example, if you add a site-level note for `github.com`, that note will apply to all pages on `github.com`, including `https://github.com/manugarg/pagenotes-issues`, for example. If a page has both page-level and site-level notes, the page-level notes take priority.

You can mark a note as site-level when you edit it. You can also change the default setting
through the options page.
You can mark a note as site-level when you edit it. You can also change the default setting through the options page.
2 changes: 1 addition & 1 deletion docs/layouts/faq/list.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<h1>{{ .Title }}</h1>
{{ .Content }}
{{ range .Pages }}
<h3><a href="{{ .RelPermalink }}">{{ .Title }}</a></h3>
<h3 id="{{ .RelPermalink | path.Base }}"><a href="{{ .RelPermalink }}">{{ .Title }}</a></h3>
{{ .Content }}
{{ end }}
{{ end }}
17 changes: 0 additions & 17 deletions docs/layouts/faqs/index.html

This file was deleted.

0 comments on commit 0d6e6e7

Please sign in to comment.