Skip to content

Commit

Permalink
Add frequently asked questions
Browse files Browse the repository at this point in the history
  • Loading branch information
manugarg committed Nov 25, 2024
1 parent 996de5f commit b070f4c
Show file tree
Hide file tree
Showing 15 changed files with 927 additions and 723 deletions.
28 changes: 28 additions & 0 deletions docs/config/_default/menus/menus.toml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,34 @@
url = "/privacy.html"
weight = 30

[[main]]
name = "FAQs"
url = "/faq/"
weight = 40

[[main]]
name = "Connect"
identifier = "connect"
weight = 50

[[main]]
name = "Github"
parent = "connect"
url = "https://github.com/manugarg/pagenotes-issues/discussions"
weight = 10

[[main]]
name = "Slack"
parent = "connect"
url = "https://join.slack.com/t/pagenotes/shared_invite/zt-1syzqesjb-24bCr8y5UyRrVBEiCpBLAQ"
weight = 20

[[main]]
name = "Blog"
parent = "connect"
url = "https://medium.com/@manugarg/10-000-users-for-page-notes-1f75786c2a41"
weight = 30

[[social]]
name = "Slack"
pre = '<svg xmlns="http://www.w3.org/2000/svg" class="feather" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M22.08 9C19.81 1.41 16.54-.35 9 1.92S-.35 7.46 1.92 15 7.46 24.35 15 22.08 24.35 16.54 22.08 9z"></path><line x1="12.57" y1="5.99" x2="16.15" y2="16.39"></line><line x1="7.85" y1="7.61" x2="11.43" y2="18.01"></line><line x1="16.39" y1="7.85" x2="5.99" y2="11.43"></line><line x1="18.01" y1="12.57" x2="7.61" y2="16.15"></line></svg>'
Expand Down
3 changes: 3 additions & 0 deletions docs/content/faq/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: 'Frequently Asked Questions'
---
10 changes: 10 additions & 0 deletions docs/content/faq/backup_restore.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: 'Backup and Restore Notes'
date: 2022-04-09T09:41:34-07:00
draft: false
weight: 4
---

You can back up your page notes from the options page. The backup is saved to
disk in CSV format. You can also restore notes from a backup from the same, options,
page.
13 changes: 13 additions & 0 deletions docs/content/faq/dark_mode_icon.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: 'How to enable dark mode icon'
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:
- 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.
- Always
- Always use dark mode icons.
- Never
- Never use dark mode icons.
7 changes: 7 additions & 0 deletions docs/content/faq/disable_icon_animation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: 'Can I disable icon animation and badge'
date: 2022-04-09T09:41:34-07:00
draft: false
weight: 5
---
Yes, you can easily disable icon animation and 'blue' badge from the options page.
14 changes: 14 additions & 0 deletions docs/content/faq/notes_popup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: 'How to automatically show notes (popup) for a webpage?'
date: 2022-04-09T09:41:34-07:00
draft: false
weight: 1
---
You can configure Page Notes to automatically show notes for a web page by changing "Automatically show notes pop-up" setting under 'Advanced Settings'. There are 3 possible values of this setting:

- Never
- Notes popup is not shown.
- Only for page-level notes (recommended):
- Notes popup is shown for the pages that have page-specific notes.
- For site-level notes as well:
- Notes popup is shown for all pages that have notes, either through page-level notes or site-level notes.
8 changes: 8 additions & 0 deletions docs/content/faq/shortcut.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: 'Can I add a keyboard shortcut to open the notes'
date: 2022-04-09T09:41:34-07:00
draft: false
weight: 3
---

Yes, it's a built-in feature in chrome. Visit `chrome://extensions/shortcuts` to create a shortcut for any extension. For example I use `^(Ctrl) + ⌘ (Cmd) + P` (on Mac) for Page Notes.
13 changes: 13 additions & 0 deletions docs/content/faq/site_level.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
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`.

You can mark a note as site-level when you edit it. You can also change the default setting
through the options page.
9 changes: 9 additions & 0 deletions docs/content/faqs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: "FAQs"
date: 2023-10-11T00:00:00Z
---

1. How do I automatically show my notes?
1. Notes popup is annoying how do I disable it?
1. Where are my notes stored?
1. How to encrypt my notes?
8 changes: 8 additions & 0 deletions docs/content/faqs2/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: "FAQs"
date: 2023-10-11T00:00:00Z
---

1. Where are my notes stored?
2. How to encrypt my notes?
2. How do I automatically show my notes?
8 changes: 8 additions & 0 deletions docs/layouts/faq/list.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{{ define "main" }}
<h1>{{ .Title }}</h1>
{{ .Content }}
{{ range .Pages }}
<h3><a href="{{ .RelPermalink }}">{{ .Title }}</a></h3>
{{ .Content }}
{{ end }}
{{ end }}
17 changes: 17 additions & 0 deletions docs/layouts/faqs/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{{ define "sidebar-prefooter" }}
<section class="section section-sm">
<div class="container">
<div class="row">
<div class="col-lg-10">
{{- .Content -}}
</div>
<div class="col-lg-4">
{{ $tpath := printf "testimonials.md" }}
{{ if (fileExists $tpath) -}}
{{ with .Site.GetPage $tpath }}
{{ .Content }}
{{ end }}
{{- end }}
</div>
</div>
{{ end }}
16 changes: 9 additions & 7 deletions docs/layouts/shortcodes/testimonial.html
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
<div class="card bg-light small">
<p class="p-2 font-italic">
"{{.Inner}}"
</p>
<footer class="blockquote-footer pt-1 border-top">
{{.Get "author"}}
</footer>
</p>
<h5 class="card-header bg-light mt-0">
⭐⭐⭐⭐⭐
</h5>
<p class="p-2 font-italic">
"{{.Inner}}"
</p>
<footer class="blockquote-footer pt-1 border-top">
{{.Get "author"}}
</footer>
</div>
Loading

0 comments on commit b070f4c

Please sign in to comment.