Initial content here
" }); return (New content
"); // Insert at cursor editor.commands.insertContent("Bold text"); // Toggle formatting editor.chain().focus().toggleBold().run(); editor.chain().focus().toggleItalic().run(); editor.chain().focus().toggleHeading({ level: 2 }).run(); // Insert special elements editor.chain().focus().insertTable({ rows: 3, cols: 3 }).run(); editor.chain().focus().setCodeBlock({ language: "javascript" }).run(); editor.chain().focus().setTaskList().run(); ``` -------------------------------- ### Run in Release Mode Source: https://github.com/streetwriters/notesnook/blob/master/apps/desktop/README.md Compile and run the application in production mode without generating packages. ```bash npm run staging -- --rebuild ``` -------------------------------- ### Initialize the Notesnook Database Source: https://context7.com/streetwriters/notesnook/llms.txt Configures the Database instance with storage, file system, and SQLite options before initialization. ```typescript import Database from "@notesnook/core"; import { SqliteDialect } from "@streetwriters/kysely"; import BetterSQLite3 from "better-sqlite3-multiple-ciphers"; // Create and configure the database instance const db = new Database(); db.setup({ storage: new NodeStorageInterface(), // Platform-specific storage implementation eventsource: EventSource, // For real-time sync updates fs: new FileStorage(), // File system for attachments compressor: async () => Compressor, // Compression for backups maxNoteVersions: async () => 1000, // Note history limit sqliteOptions: { dialect: (name) => new SqliteDialect({ database: BetterSQLite3(":memory:").unsafeMode(true) }), password: "optional-encryption-password" }, batchSize: 500 }); // Initialize the database (creates tables, runs migrations) await db.init(); console.log("Database initialized:", db.isInitialized); // Output: Database initialized: true ``` -------------------------------- ### Define Application Styles Source: https://github.com/streetwriters/notesnook/blob/master/apps/theme-builder/src/index.html CSS rules for splash screen, skeleton loaders, and layout responsiveness. ```css #splash { display: none !important; } html { overscroll-behavior: none; } html[data-theme="light"] .react-loading-skeleton { --base-color: var(--background-secondary); --highlight-color: #var(--background-secondary); } html[data-theme="dark"] .react-loading-skeleton { --base-color: var(--background-secondary); --highlight-color: var(--background-secondary); } #splash { background-color: var(--background); height: 100%; width: 100%; position: absolute; top: 0; left: 0; display: flex; flex-direction: column; justify-content: center; align-items: center; } #splash svg { transform: scale(1); animation: pulse 2s infinite; } @keyframes pulse { 0% { transform: scale(0.9); } 70% { transform: scale(1); } 100% { transform: scale(0.9); } } html, body { font-size: 16px; } @media only screen and (max-width: 480px) { html, body { font-size: 18px; background-color: var(--background); } } :root, body, #root { margin: 0 !important; height: 100%; overflow: hidden; } #root { display: flex; flex-direction: column; } /* svg { width: 1.5rem; } */ .ReactModal__Overlay { opacity: 0; transition: opacity 200ms ease-in-out; } .ReactModal__Overlay--after-open { opacity: 1; } .ReactModal__Overlay--before-close { opacity: 0; } .slide { background-color: transparent !important; } .carousel.carousel-slider { display: flex; flex-direction: row; } ``` -------------------------------- ### Switch iOS Build Configuration Source: https://github.com/streetwriters/notesnook/blob/master/apps/mobile/ios/build-configs/README.md Execute this script from the 'apps/mobile' directory to set the active build configuration to 'production' or 'staging'. ```bash bash ios/build-configs/use-ios-build-config.sh production ``` ```bash bash ios/build-configs/use-ios-build-config.sh staging ``` -------------------------------- ### Navigate to web clipper directory Source: https://github.com/streetwriters/notesnook/blob/master/extensions/web-clipper/README.md Change the working directory to the web clipper folder. ```sh cd extensions/web-clipper ``` -------------------------------- ### Build iOS App with Specific Config Source: https://github.com/streetwriters/notesnook/blob/master/apps/mobile/ios/build-configs/README.md Compile the iOS application directly using a specific configuration file, such as 'ios-build.staging.xcconfig'. ```bash xcodebuild \ -workspace ios/Notesnook.xcworkspace \ -scheme Notesnook \ -configuration Release \ -xcconfig ios/build-configs/ios-build.staging.xcconfig ``` -------------------------------- ### Android Release Commands Source: https://github.com/streetwriters/notesnook/blob/master/apps/mobile/README.md Helper commands for generating release builds of the Notesnook Android application. ```bash npm run release:android npm run release:android:bundle ``` -------------------------------- ### Build iOS App with Active Config Source: https://github.com/streetwriters/notesnook/blob/master/apps/mobile/ios/build-configs/README.md Use xcodebuild to compile the iOS application, referencing the active configuration file. Ensure you are in the 'apps/mobile' directory. ```bash xcodebuild \ -workspace ios/Notesnook.xcworkspace \ -scheme Notesnook \ -configuration Release \ -xcconfig ios/build-configs/ios-build.active.xcconfig ``` -------------------------------- ### Application CSS Styles Source: https://github.com/streetwriters/notesnook/blob/master/apps/web/src/index.html Global CSS styles for themes, splash screen animations, and layout constraints. ```css html { overscroll-behavior: none; } html[data-theme="light"] .react-loading-skeleton { --base-color: var(--background-secondary); --highlight-color: #var(--background-secondary); } html[data-theme="dark"] .react-loading-skeleton { --base-color: var(--background-secondary); --highlight-color: var(--background-secondary); } #splash { background-color: var(--background); height: 100%; width: 100%; position: absolute; top: 0; left: 0; display: flex; flex-direction: column; justify-content: center; align-items: center; } #splash svg { transform: scale(1); animation: pulse 2s infinite; } @keyframes pulse { 0% { transform: scale(0.9); } 70% { transform: scale(1); } 100% { transform: scale(0.9); } } html, body { font-size: 16px; } @media only screen and (max-width: 480px) { html, body { font-size: 18px; background-color: var(--background); } } :root, body, #root { margin: 0 !important; height: 100%; overflow: hidden; } #root { display: flex; flex-direction: column; } /* svg { width: 1.5rem; } */ .ReactModal__Overlay { opacity: 0; transition: opacity 200ms ease-in-out; } .ReactModal__Overlay--after-open { opacity: 1; } .ReactModal__Overlay--before-close { opacity: 0; } .slide { background-color: transparent !important; } .carousel.carousel-slider { display: flex; flex-direction: row; } ``` -------------------------------- ### Run tests Source: https://github.com/streetwriters/notesnook/blob/master/apps/web/README.md Execute the end-to-end test suite using Playwright. ```bash npm run test:web ``` -------------------------------- ### Build and Run Android E2E Tests Source: https://github.com/streetwriters/notesnook/blob/master/apps/mobile/README.md Build and execute end-to-end tests for the Android version of the app using Detox. Includes commands for both release and debug configurations. ```bash npm run build:android npm run test:android ``` ```bash npm run build:android:debug npm run start:metro npm run test:android:debug ``` -------------------------------- ### Manage Notebooks and Notes Source: https://context7.com/streetwriters/notesnook/llms.txt Create, link, and query notebooks and sub-notebooks. Assign notes to notebooks and manage their hierarchy. Supports operations like pinning, deleting, and retrieving counts. ```typescript // Create a notebook const notebookId = await db.notebooks.add({ title: "Work Projects", description: "All my work-related notes" }); ``` ```typescript // Create a sub-notebook const subNotebookId = await db.notebooks.add({ title: "Q1 2024 Projects" }); ``` ```typescript // Link sub-notebook to parent notebook await db.relations.add( { type: "notebook", id: notebookId }, { type: "notebook", id: subNotebookId } ); ``` ```typescript // Add note to notebook await db.notes.addToNotebook(subNotebookId, noteId); ``` ```typescript // Get all root notebooks (no parent) const rootNotebooks = await db.notebooks.roots.items(); ``` ```typescript // Get all notebooks const allNotebooks = await db.notebooks.all.items(); ``` ```typescript // Get notebook by ID const notebook = await db.notebooks.notebook(notebookId); console.log(notebook?.title); // Output: "Work Projects" ``` ```typescript // Find notebook by title const foundNotebook = await db.notebooks.find("Work Projects"); ``` ```typescript // Get breadcrumbs for navigation const breadcrumbs = await db.notebooks.breadcrumbs(subNotebookId); // Output: [{ id: "...", title: "Work Projects" }, { id: "...", title: "Q1 2024 Projects" }] ``` ```typescript // Get total notes count in notebook (including sub-notebooks) const [totalNotes] = await db.notebooks.totalNotes(notebookId); ``` ```typescript // Get all note IDs in notebook hierarchy const noteIds = await db.notebooks.notes(notebookId); ``` ```typescript // Remove note from notebook await db.notes.removeFromNotebook(notebookId, noteId); ``` ```typescript // Pin notebook await db.notebooks.pin(true, notebookId); ``` ```typescript // Delete notebook (moves to trash) await db.notebooks.moveToTrash(notebookId); ``` -------------------------------- ### Run Prettier code formatter Source: https://github.com/streetwriters/notesnook/blob/master/CONTRIBUTING.md Format your code using Prettier to ensure consistent style. Run this command after making code changes. ```bash npm run prettier ``` -------------------------------- ### Run core tests Source: https://github.com/streetwriters/notesnook/blob/master/packages/core/README.md Execute the Jest test suite to verify the core functionality. ```bash npm run test:core ``` -------------------------------- ### Run ESLint linter Source: https://github.com/streetwriters/notesnook/blob/master/CONTRIBUTING.md Check your code for styling issues using ESLint. This command helps catch most style problems. ```bash npm run lint ``` -------------------------------- ### Create and Process Backups Source: https://context7.com/streetwriters/notesnook/llms.txt Generate encrypted or unencrypted backups of your data using `db.backup.export()`. The export function returns a generator for handling backup chunks, including files and attachments. Use `db.backup.import()` to restore data. ```typescript // Create backup (generator for chunked output) const backupGenerator = db.backup.export({ type: "web", // "web" | "mobile" | "node" encrypt: true, // Encrypt backup with user key mode: "full" // "full" | "partial" }); // Process backup chunks for await (const chunk of backupGenerator) { if (chunk.type === "file") { // Save backup file console.log(`Backup chunk: ${chunk.path}`); await saveFile(chunk.path, chunk.data); } else if (chunk.type === "attachment") { // Handle attachment export console.log(`Attachment ${chunk.current}/${chunk.total}: ${chunk.hash}`); } } // Get last backup time const lastBackupTime = await db.backup.lastBackupTime(); // Restore from backup const backupFile = JSON.parse(backupFileContent); await db.backup.import(backupFile, "user-password"); ``` -------------------------------- ### Manage Notes Collection Source: https://context7.com/streetwriters/notesnook/llms.txt Demonstrates creating, updating, retrieving, organizing, and deleting notes within the Notesnook database. ```typescript // Add a new note with content const noteId = await db.notes.add({ title: "My First Note", content: { type: "tiptap", data: "Hello, this is my encrypted note content!
" } }); // Retrieve the note const note = await db.notes.note(noteId); console.log(note?.title); // Output: "My First Note" // Get note content const content = await db.content.get(note.contentId); console.log(content?.data); // Output: "Hello, this is my encrypted note content!
" // Update note properties await db.notes.add({ id: noteId, title: "Updated Title", content: { type: "tiptap", data: "Updated content with bold text
" } }); // Pin, favorite, and archive notes await db.notes.pin(true, noteId); await db.notes.favorite(true, noteId); await db.notes.archive(true, noteId); // Get all notes with filtering const allNotes = await db.notes.all.items(); const pinnedNotes = await db.notes.pinned.items(); const favoriteNotes = await db.notes.favorites.items(); const archivedNotes = await db.notes.archived.items(); // Export note to different formats const htmlExport = await db.notes.export(noteId, { format: "html" }); const markdownExport = await db.notes.export(noteId, { format: "md" }); const textExport = await db.notes.export(noteId, { format: "txt" }); // Delete note (move to trash) await db.notes.moveToTrash(noteId); // Permanently delete note await db.notes.remove(noteId); ``` -------------------------------- ### StreamableFS File Operations Source: https://context7.com/streetwriters/notesnook/llms.txt Shows how to use StreamableFS for creating, writing, reading, and deleting files in IndexedDB using a streaming interface. Supports chunked operations and provides methods for checking existence, listing, moving, and clearing files. ```typescript import { StreamableFS } from "@notesnook/streamable-fs"; // Create instance with storage backend const fs = new StreamableFS(indexedDBStorage); // Create a new file const fileHandle = await fs.createFile( "document.pdf", 1024000, // size in bytes "application/pdf", { overwrite: true } ); // Write data in chunks const writer = fileHandle.writeable; await writer.write(chunk1); await writer.write(chunk2); await writer.close(); // Read file const readHandle = await fs.readFile("document.pdf"); if (readHandle) { // Get readable stream const reader = readHandle.readable; // Or read as blob const blob = await readHandle.toBlob(); // Get file info console.log(readHandle.file); // Output: { filename: "document.pdf", size: 1024000, type: "application/pdf" } } // Check if file exists const exists = await fs.exists("document.pdf"); // List all files const files = await fs.list(); // Delete file await fs.deleteFile("document.pdf"); // Bulk delete files await fs.bulkDeleteFiles(["file1.pdf", "file2.pdf"]); // Move file const sourceHandle = await fs.readFile("source.pdf"); const destHandle = await fs.createFile("dest.pdf", sourceHandle.file.size, sourceHandle.file.type); await fs.moveFile(sourceHandle, destHandle); // Clear all files await fs.clear(); ```