Merge pull request #55 from biggraph/darabos-mkdocs

README.md

@@ -14,6 +14,7 @@ original LynxKite. The primary goals of this rewrite are:
 - `lynxkite-graph-analytics`: Graph analytics plugin. The classical LynxKite experience!
 - `lynxkite-pillow`: A simple example plugin.
 - `lynxkite-lynxscribe`: A plugin for building and running LynxScribe applications.
+- `docs`: User-facing documentation. It's shared between all packages.
 
 ## Development
 
@@ -38,3 +39,12 @@ If you also want to make changes to the frontend with hot reloading:
 cd lynxkite-app/web
 npm run dev
 ```
+
+## Documentation
+
+To work on the documentation:
+
+```bash
+uv pip install mkdocs-material mkdocstrings[python]
+mkdocs serve
+```

docs/index.md

@@ -0,0 +1,3 @@
+# Getting started
+
+Good luck getting started!

docs/lynxkite-core.md

@@ -0,0 +1,6 @@
+# LynxKite Core
+
+LynxKite core is for writing LynxKite plugins.
+It contains core types and utilities that can be used by all LynxKite plugins.
+
+::: lynxkite.core.ops

docs/lynxkite-graph-analytics.md

@@ -0,0 +1,6 @@
+# LynxKite Graph Analytics
+
+This is the classical LynxKite experience!
+The graph analytics plugin is a collection of graph algorithms that can be run on a LynxKite graph.
+
+::: lynxkite_plugins.graph_analytics.lynxkite_ops

docs/stylesheets/extra.css

@@ -0,0 +1,8 @@
+[data-md-color-scheme="lynxkite"] {
+  --md-primary-fg-color: #39bcf9;
+  --md-primary-fg-color--light: #9fdef9;
+  --md-primary-fg-color--dark: #096f9a;
+  --md-accent-fg-color: #ff8800;
+  --md-accent-fg-color--dark: #b86200;
+  --md-accent-fg-color--light: #ffbc70;
+}

mkdocs.yml

@@ -0,0 +1,25 @@
+site_name: "LynxKite"
+repo_url: https://github.com/lynxkite/lynxkite
+repo_name: lynxkite/lynxkite
+
+theme:
+  name: "material"
+  palette:
+    scheme: lynxkite
+  logo: "assets/lynxkite-icon-white.png"
+  favicon: "assets/lynxkite-icon-white.png"
+  features:
+    - navigation.tabs
+    - navigation.path
+    - navigation.instant
+    - navigation.instant.prefetch
+
+extra_css:
+  - stylesheets/extra.css
+
+plugins:
+- search
+- mkdocstrings:
+    handlers:
+      python:
+        paths: ["./lynxkite-app/src", "./lynxkite-core/src", "./lynxkite-graph-analytics/src", "./lynxkite-lynxscribe/src"]