From e5bbec270382f13002fd802a6b12f969c8b65006 Mon Sep 17 00:00:00 2001 From: ptdewey Date: Wed, 11 Dec 2024 11:45:09 -0500 Subject: [PATCH] what is oolong page and wip organization --- docs/.vitepress/config.mts | 23 +++++++++++---- docs/getting-started.md | 27 ------------------ docs/guide/getting-started.md | 38 +++++++++++++++++++++++++ docs/guide/what-is-oolong.md | 53 +++++++++++++++++++++++++++++++++++ docs/index.md | 15 ++++------ 5 files changed, 115 insertions(+), 41 deletions(-) delete mode 100644 docs/getting-started.md create mode 100644 docs/guide/getting-started.md create mode 100644 docs/guide/what-is-oolong.md diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 12946ae..e115e73 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -7,17 +7,30 @@ export default defineConfig({ themeConfig: { // https://vitepress.dev/reference/default-theme-config nav: [ - { text: "Home", link: "/" }, - { text: "Guide", link: "/what-is-oolong" }, - { text: "Examples", link: "/markdown-examples" }, + { text: "Guide", link: "/guide/getting-started" }, + { text: "Reference", link: "/reference/configuration-overview" }, + { text: "Showcase", link: "/showcase" }, ], sidebar: [ { text: "Introduction", items: [ - { text: "What is Oolong", link: "/what-is-oolong" }, - { text: "Getting Started", link: "/getting-started" }, + { text: "What is Oolong?", link: "/guide/what-is-oolong" }, + { text: "Getting Started", link: "/guide/getting-started" }, + ], + }, + { + text: "Reference", + items: [ + { text: "Configuration", link: "/reference/configuration-overview" }, + ], + }, + { + text: "Showcase", + items: [ + { text: "Graph", link: "/graph-showcase" }, + { text: "Editor", link: "/editor-showcase" }, ], }, { diff --git a/docs/getting-started.md b/docs/getting-started.md deleted file mode 100644 index 1dee8d6..0000000 --- a/docs/getting-started.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -outline: deep ---- - -# Getting Started - -## Installation - - - -### Oolongd (Daemon) - -Oolongd can be installed with go install: -```sh -go install github.com/oolong-sh/oolongd -``` - -It can also be built from source: -```sh -git clone https://github.com/oolong-sh/oolongd.git -cd oolongd -go build -``` - -### Oolong Web Editor - - diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md new file mode 100644 index 0000000..819321f --- /dev/null +++ b/docs/guide/getting-started.md @@ -0,0 +1,38 @@ +--- +outline: deep +editLink: true +--- + +# Getting Started + +Oolong is made up of two components: +- **Oolongd**: The daemon that indexes and links your notes, enables cloud synchronization, and provides an API that powers the Oolong editor. +- **Oolong Editor**: Our custom editor built to run from a browser or natively for any desktop operating system. + - Oolong Editor requires Oolongd to be installed, but it can be configured to run on a remote server, allowing you to take notes and view your graph from anywhere with an internet connection. + + +## Installation + +Oolongd and Oolong Editor currently must be installed separately (but we are working on creating a bundled version). + +### Oolongd (Daemon) + +Oolongd can be installed with go install: +```sh +go install github.com/oolong-sh/oolongd +``` + +It can also be built from source: +```sh +git clone https://github.com/oolong-sh/oolongd.git +cd oolongd +go build +``` + +### Oolong Web Editor + + + +## Usage + +Oolongd is capable of running entirely on its own (without the Oolong editor), allowing you to use your editor of choice. Oolongd also includes the knowledge graph view, available directly in your web browser at [http://localhost:11975](http://localhost:11975). diff --git a/docs/guide/what-is-oolong.md b/docs/guide/what-is-oolong.md new file mode 100644 index 0000000..ca15f25 --- /dev/null +++ b/docs/guide/what-is-oolong.md @@ -0,0 +1,53 @@ +--- +outline: deep +--- + +# What is Oolong? + +Oolong is a revolutionary note-taking and aggregation tool designed for thinkers, creators, and professionals who demand flexibility, power, and control. Built around the principles of openness and usability, Oolong harnesses the power of common plain text formats like **Markdown**, **Typst**, and **LaTeX** to deliver a note-taking experience like no other. Whether you’re a student, researcher, or creative professional, Oolong empowers you to capture ideas, connect them, and see the bigger picture. + +## Why Choose Oolong? + +### Freedom and Flexibility + +- **Open Standards, Open Possibilities**: Your notes, your way. Oolong uses pure Markdown and LaTeX formats, so you’ll never be locked into a single tool or vendor. +- **Total Data Control**: Own your notes and your workflow. With self-hosting options and no proprietary formats, your ideas are yours forever. + +### Discover the Hidden Connections + +- **NLP-Powered Keyword Extraction**: Let Oolong's smart algorithms do the heavy lifting, surfacing key ideas and recurring themes in your notes. +- **Dynamic Note Linking**: Effortlessly connect related thoughts and ideas across your notes. +- **Interactive Graph View**: Dive into a stunning visualization of your knowledge network. Explore the connections, uncover patterns, and turn isolated notes into a web of insight. + +### Tools That Work the Way You Do + +- **Customizable Organization**: Arrange notes hierarchically or in tree structures, and sort them by topics, tags, or any characteristic you choose. +- **Insights at Your Fingertips**: With built-in word frequency analysis and advanced search tools, finding what matters has never been easier. + +### Designed for Modern Life + +- **Quick-Note Creation**: Jot down thoughts, meeting notes, or journal entries instantly with configurable templates. +- **Effortless Sharing**: Transform notes into polished HTML or PDF documents with a click. +- **Seamless Synchronization**: Keep your notes in sync across devices with our cloud service—or take full control with self-hosted options. + +## What Sets Oolong Apart? + +Unlike typical note-taking apps that trap you in proprietary ecosystems, Oolong puts the power back in your hands: +- **Break Free from Lock-In**: Say goodbye to restrictive formats and closed platforms. +- **Prioritize Privacy**: Your data is yours alone, with self-hosting options that keep your notes off third-party servers. +- **Think Bigger**: Go beyond basic organization with advanced analytical tools and groundbreaking visualization features. + +## Who is Oolong For? + +Oolong is for anyone who: +- Values open, standardized formats and long-term data ownership. +- Wants powerful tools for organizing, analyzing, and linking ideas. +- Needs the flexibility to work anywhere—online or offline, cloud or local. + +## How Oolong Works + +Oolong combines cutting-edge technologies to deliver a seamless experience: +- **Backend**: Built in **Go**, the backend provides rock-solid performance for processing and synchronization. +- **Frontend**: A modern **JavaScript** interface for intuitive editing and organization. +- **Deployment**: Oolong uses containerization for streamlined installation and maintenance. + diff --git a/docs/index.md b/docs/index.md index 66e7730..ee22cb4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,21 +4,18 @@ layout: home hero: name: "Oolong" - text: "Next Gen Notes" - tagline: My great project tagline + # text: "Next Gen Notes" + tagline: "Simple, Open Notes" actions: - theme: brand text: What is Oolong? - link: /what-is-oolong + link: /guide/what-is-oolong - theme: alt text: Getting Started - link: /getting-started + link: /guide/getting-started - theme: alt - text: Markdown Examples - link: /markdown-examples - - theme: alt - text: API Examples - link: /api-examples + text: Configuration + link: /reference/configuration-overview features: - title: Feature A