Skip to content

Commit

Permalink
what is oolong page and wip organization
Browse files Browse the repository at this point in the history
  • Loading branch information
ptdewey committed Dec 11, 2024
1 parent 8197037 commit e5bbec2
Show file tree
Hide file tree
Showing 5 changed files with 115 additions and 41 deletions.
23 changes: 18 additions & 5 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -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" },
],
},
{
Expand Down
27 changes: 0 additions & 27 deletions docs/getting-started.md

This file was deleted.

38 changes: 38 additions & 0 deletions docs/guide/getting-started.md
Original file line number Diff line number Diff line change
@@ -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

<!-- TODO: -->

## 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).
53 changes: 53 additions & 0 deletions docs/guide/what-is-oolong.md
Original file line number Diff line number Diff line change
@@ -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.

15 changes: 6 additions & 9 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit e5bbec2

Please sign in to comment.