Mirrors/notesnook
1
0
Fork 0
mirror of https://github.com/streetwriters/notesnook.git synced 2026-08-29 10:09:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

global: move everything to notesnook.com/help/* (#10238)

Browse Source
This commit is contained in:
Abdullah Atta
2026-08-14 12:34:07 +05:00
committed by GitHub
parent 52d6044e73
commit 87aa98b85e
33 changed files with 1591 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/help/.gitignore vendored
View File

@@ -2,3 +2,4 @@
.vitepress/cache
contents/v*/
.vitepress/sidebars/generated.mjs
.wrangler

15
docs/help/.vitepress/config.mts
View File

@@ -21,19 +21,22 @@ export default defineConfig({
"Your complete and free resource to using Notesnook as a daily note taking app to organize your work and life while safeguarding your privacy.",
lang: "en-US",
srcDir: "./contents",
base: "/help/",
outDir: "./.vitepress/dist/help",
// Version overrides are source material for build-versions.mjs, not pages.
// The Standard Notes importer is unpublished for now — the page is kept in
// the repo but is not built, linked or listed in the sitemap. Delete the
// second entry (and restore the sidebar link) to publish it again.
srcExclude: [
"_versions/**",
"importing-notes/import-notes-from-standardnotes.md"
"importing-notes/import-notes-from-standardnotes.md",
"self-hosting.md"
],
cleanUrls: true,
lastUpdated: true,
metaChunk: true,
sitemap: {
hostname: "https://help.notesnook.com",
hostname: "https://notesnook.com/help",
// Only the latest docs belong in the sitemap.
transformItems: (items) =>
items.filter(
@@ -69,7 +72,7 @@ export default defineConfig({
"link",
{
rel: "preload",
href: "/fonts/Inter-Regular.woff2",
href: "/help/fonts/Inter-Regular.woff2",
as: "font",
type: "font/woff2",
crossorigin: ""
@@ -79,7 +82,7 @@ export default defineConfig({
"link",
{
rel: "preload",
href: "/fonts/Inter-SemiBold.woff2",
href: "/help/fonts/Inter-SemiBold.woff2",
as: "font",
type: "font/woff2",
crossorigin: ""
@@ -94,9 +97,9 @@ export default defineConfig({
{
async: "",
defer: "",
"data-website-id": "ad34576b-2721-436c-b36a-47a614009d2b",
"data-website-id": "676a7449-2151-44f7-a8c7-3b0691cade30",
src: "https://aas.streetwriters.co/script.js",
"data-domains": "help.notesnook.com"
"data-domains": "notesnook.com"
}
]
],

9
docs/help/.vitepress/seo.mts
View File

@@ -21,14 +21,13 @@ import { join } from "node:path";
import type { HeadConfig, TransformPageContext, PageData } from "vitepress";
import { resolveString } from "./strings.mjs";
const SITE = "https://help.notesnook.com";
const SITE = "https://notesnook.com/help";
const OG_IMAGE = `${SITE}/logo.png`;
const url = (relativePath: string) =>
`${SITE}/${relativePath.replace(/(index)?\.md$/, "").replace(/\/$/, "")}`.replace(
/\/$/,
""
) || SITE;
`${SITE}/${relativePath
.replace(/(index)?\.md$/, "")
.replace(/\/$/, "")}`.replace(/\/$/, "") || SITE;
/** "organizing-notes/archive-notes.md" -> ["Organizing notes", "Archive notes"] */
function breadcrumbs(relativePath: string, title: string) {

2
docs/help/README.md
View File

@@ -1,6 +1,6 @@
# Notesnook Help
The source of [help.notesnook.com](https://help.notesnook.com), built with [VitePress](https://vitepress.dev).
The source of [notesnook.com/help](https://notesnook.com/help), built with [VitePress](https://vitepress.dev).
```bash
npm install

2
docs/help/STYLE.md
View File

@@ -1,6 +1,6 @@
# Help docs — writing conventions
Every page on help.notesnook.com follows these. They cover accuracy, plan tags, SEO and linking.
Every page on notesnook.com/help follows these. They cover accuracy, plan tags, SEO and linking.
## 1. Accuracy is non-negotiable

1
docs/help/contents/how-is-my-data-encrypted.md
View File

@@ -113,4 +113,3 @@ Your data encryption key is created the next time you change your password.
- [Recovering your account](/recovering-your-account) — when you forget your password
- [Backup and restore](/backup-and-restore-notes-in-notesnook) — keeping your own encrypted copy
- [Two-factor authentication](/two-factor-authentication) — a second step at login
- [Self-hosting](/self-hosting) — running your own servers

1
docs/help/contents/inbox-api/self-hosting-inbox-api.md
View File

@@ -138,5 +138,4 @@ After rotating your PGP keys in Notesnook settings, re-fetch the public key (Ste
## Related pages
- [Inbox API](/inbox-api/getting-started) — sending notes in from other services
- [Self-hosting](/self-hosting) — running your own servers
- [How is my data encrypted?](/how-is-my-data-encrypted) — the encryption behind every note

2
docs/help/contents/public/robots.txt
View File

@@ -2,4 +2,4 @@
User-agent: *
Allow: /
Sitemap: https://help.notesnook.com/sitemap.xml
Sitemap: https://notesnook.com/help/sitemap.xml

1
docs/help/contents/sync/sync-settings.md
View File

@@ -150,4 +150,3 @@ If you are here because something is not syncing, try the ordinary fixes in [syn
- [Plans & limits](/plans-and-limits) — full offline mode needs Essential, sync controls need Pro
- [Backup and restore](/backup-and-restore-notes-in-notesnook) — take one before any forced sync
- [What are merge conflicts?](/faqs/what-are-merge-conflicts) — resolving two versions of the same note
- [Self-hosting](/self-hosting) — pointing sync at your own server instead

3
docs/help/contents/sync/troubleshooting-sync.md
View File

@@ -83,7 +83,7 @@ Stop pressing sync, wait a few minutes, and let the app sync on its own. If you
| Message | What it means | What to do |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| _(no message — only the status flips to `{{syncFailed}}`)_ | The app could not open a connection to the sync server within 30 seconds. Connection failures are written to the log as `Could not connect to the Sync server. Please try again.` but are deliberately not shown as a toast. | Check your connection, then sync again. Behind a strict firewall or VPN, try another network. |
| `Notesnook Sync Server is not responding. Please check your internet connection.` (the full message goes on to give a support address and a reference error) | The server did not answer at all. Other names you may see are `Authentication Server`, `Eventing Server` and `Monograph Server`. If you have pointed the app at your own servers you get the raw network error instead of this friendly one. | Check your connection. If you are [self-hosting](/self-hosting), check that server is up. |
| `Notesnook Sync Server is not responding. Please check your internet connection.` (the full message goes on to give a support address and a reference error) | The server did not answer at all. Other names you may see are `Authentication Server`, `Eventing Server` and `Monograph Server`. If you have pointed the app at your own servers you get the raw network error instead of this friendly one. | Check your connection. |
| `You are being rate limited.` | Too many requests. | Wait a few minutes. |
| `Unauthorized.` | Your session is no longer valid. | Log out and log back in. |
| `Failed to send all items. Sent X out of Y.` | The upload stopped partway. | Sync again — the remaining items are still queued and go out on the next run. |
@@ -155,4 +155,3 @@ Send the details to support@streetwriters.co — which devices, what the status
- [What are merge conflicts?](/faqs/what-are-merge-conflicts) — resolving a conflicted note step by step
- [Backup and restore](/backup-and-restore-notes-in-notesnook) — take one before any forced sync
- [Plans & limits](/plans-and-limits) — storage allowances and which sync features need a paid plan
- [Self-hosting](/self-hosting) — sync errors when you run your own servers

1513
docs/help/package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

3
docs/help/package.json
View File

@@ -34,6 +34,7 @@
"@notesnook/intl": "file:../../packages/intl",
"markdown-it-task-lists": "^2.1.1",
"vitepress": "^1.6.4",
"vitepress-plugin-tabs": "^0.9.1"
"vitepress-plugin-tabs": "^0.9.1",
"wrangler": "^4.123.0"
}
}

18
docs/help/wrangler.jsonc Normal file
View File

@@ -0,0 +1,18 @@
{
"name": "notesnook-help",
"routes": [
{
"pattern": "notesnook.com/help/*",
"zone_name": "notesnook.com"
},
{
"pattern": "notesnook.com/help",
"zone_name": "notesnook.com"
}
],
"compatibility_date": "2026-08-14",
"preview_urls": true,
"assets": {
"directory": "./.vitepress/dist"
}
}