diff --git a/AGENTS.md b/AGENTS.md index 92fe3f57..eb172d99 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -159,7 +159,7 @@ The FluffOS documentation site lives in the `docs/` directory and is built with ### Framework & Build -* **Framework**: Docusaurus 3 (`@docusaurus/preset-classic`). Do **not** confuse with VitePress — the site was migrated from VitePress and `.vitepress/` is a dead directory that can be ignored. +* **Framework**: Docusaurus 3 (`@docusaurus/preset-classic`). Do **not** confuse with VitePress or Jekyll — the site was migrated from those frameworks and their leftover directories (`.vitepress/`, `_layouts/`, `css/`) have been removed. * **Node**: Use NVM. The active version is managed via `~/.nvm`. Always `source "$NVM_DIR/nvm.sh"` before running npm commands. * **Key config files**: - `docs/docusaurus.config.ts` — site config, navbar, footer, docs plugin path diff --git a/README.md b/README.md index e2efb230..2020918a 100644 --- a/README.md +++ b/README.md @@ -303,7 +303,7 @@ cd testsuite - **`src/compiler/`**: LPC parsing engine (`grammar.y`, `lex.cc`, `generate.cc`). - **`src/packages/`**: Modular efun features (math, db, crypto, sockets, etc.). - **`testsuite/`**: Official testsuite containing LPC tests and configurations. -- **`docs/`**: Markdown documentation. +- **`docs/`**: Documentation site (Markdown, built with Docusaurus — see [docs/README.md](docs/README.md)). --- diff --git a/docs/.gitignore b/docs/.gitignore index 9e8ec21f..364cdc24 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,8 +1,3 @@ -/vendor -/Gemfile.lock -/_site /node_modules -/.vitepress/cache -/.vitepress/dist /build /.docusaurus diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts deleted file mode 100644 index 9d93e373..00000000 --- a/docs/.vitepress/config.mts +++ /dev/null @@ -1,53 +0,0 @@ -import { defineConfig } from 'vitepress' -import SIDEBAR from "./sidebar"; - -// https://vitepress.dev/reference/site-config -export default defineConfig({ - lang: 'en-US', - title: "FluffOS Docs", - description: "Docs for FluffOS Project", - lastUpdated: true, - sitemap: { - hostname: 'https://www.fluffos.info' - }, - themeConfig: { - // https://vitepress.dev/reference/default-theme-config - nav: [ - { text: 'Github', link: 'https://github.com/fluffos/fluffos' } - ], - sidebar: SIDEBAR, - search: { - provider: 'local', - options: { - miniSearch: { - /** - * @type {Pick} - */ - options: { - }, - /** - * @type {import('minisearch').SearchOptions} - * @default - * { fuzzy: 0.2, prefix: true, boost: { title: 4, text: 2, titles: 1 } } - */ - searchOptions: { - fuzzy: 0.1, - prefix: true, - fields: [ 'relativePath', 'title' ], - boost: { - title: 4, - text: 2, - titles: 1 - } - } - } - } - }, - socialLinks: [ - { icon: 'github', link: 'https://github.com/fluffos/fluffos' } - ], - editLink: { - pattern: 'https://github.com/fluffos/fluffos/edit/master/docs/:path' - }, - } -}) diff --git a/docs/.vitepress/sidebar.ts b/docs/.vitepress/sidebar.ts deleted file mode 100644 index b41bdb7c..00000000 --- a/docs/.vitepress/sidebar.ts +++ /dev/null @@ -1,68 +0,0 @@ -const SIDEBAR = [ - { - text: 'Introduction', - collapsed: false, - items: [ - {text: 'FluffOS', link: '/'}, - {text: 'Getting Started', link: '/build.html'}, - {text: 'Troubleshooting', link: '/bug.html'} - ] - }, - { - text: 'CLI', - collapsed: false, - items: [ - {text: 'driver', link: '/cli/driver.html'}, - {text: 'lpcc', link: '/cli/lpcc.html'}, - {text: 'o2json', link: '/cli/o2json.html'}, - {text: 'json2o', link: '/cli/json2o.html'} - ] - }, - { - text: 'LPC', - items: [ - {text: 'LPC Language', link: '/lpc/'}, - {text: 'Driver', link: '/driver/'}, - ] - }, - { - text: 'Reference', - items: [ - { - text: 'Apply', - link: '/apply/', - collapsed: true, - items: [ - {text: 'Master', link: '/apply/master/'}, - {text: 'Interactive', link: '/apply/interactive/'}, - {text: 'Object', link: '/apply/object/'}, - ] - }, - {text: 'EFUN', link: '/efun/'}, - {text: 'LPC Library', link: '/stdlib/'} - ] - }, - { - text: 'Driver Internal', - items: [ - {text: 'Concepts', link: '/concepts/'}, - {text: 'Notes', link: '/driver/'}, - ] - }, - { - text: '中文文档', - items: [ - {text: '编译文档', link: '/zh-CN/build/'}, - {text: 'Apply 文档', link: '/zh-CN/apply/'}, - {text: 'EFUN 文档', link: '/zh-CN/efun/'}, - ] - }, - { - text: 'Historical', - items: [ - {text: 'Build (v2017)', link: '/build_v2017.html'} - ] - }, -] - -export default SIDEBAR; \ No newline at end of file diff --git a/docs/.vitepress/theme/index.ts b/docs/.vitepress/theme/index.ts deleted file mode 100644 index def4cfc8..00000000 --- a/docs/.vitepress/theme/index.ts +++ /dev/null @@ -1,17 +0,0 @@ -// https://vitepress.dev/guide/custom-theme -import { h } from 'vue' -import type { Theme } from 'vitepress' -import DefaultTheme from 'vitepress/theme' -import './style.css' - -export default { - extends: DefaultTheme, - Layout: () => { - return h(DefaultTheme.Layout, null, { - // https://vitepress.dev/guide/extending-default-theme#layout-slots - }) - }, - enhanceApp({ app, router, siteData }) { - // ... - } -} satisfies Theme diff --git a/docs/.vitepress/theme/style.css b/docs/.vitepress/theme/style.css deleted file mode 100644 index d63aee82..00000000 --- a/docs/.vitepress/theme/style.css +++ /dev/null @@ -1,139 +0,0 @@ -/** - * Customize default theme styling by overriding CSS variables: - * https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css - */ - -/** - * Colors - * - * Each colors have exact same color scale system with 3 levels of solid - * colors with different brightness, and 1 soft color. - * - * - `XXX-1`: The most solid color used mainly for colored text. It must - * satisfy the contrast ratio against when used on top of `XXX-soft`. - * - * - `XXX-2`: The color used mainly for hover state of the button. - * - * - `XXX-3`: The color for solid background, such as bg color of the button. - * It must satisfy the contrast ratio with pure white (#ffffff) text on - * top of it. - * - * - `XXX-soft`: The color used for subtle background such as custom container - * or badges. It must satisfy the contrast ratio when putting `XXX-1` colors - * on top of it. - * - * The soft color must be semi transparent alpha channel. This is crucial - * because it allows adding multiple "soft" colors on top of each other - * to create a accent, such as when having inline code block inside - * custom containers. - * - * - `default`: The color used purely for subtle indication without any - * special meanings attched to it such as bg color for menu hover state. - * - * - `brand`: Used for primary brand colors, such as link text, button with - * brand theme, etc. - * - * - `tip`: Used to indicate useful information. The default theme uses the - * brand color for this by default. - * - * - `warning`: Used to indicate warning to the users. Used in custom - * container, badges, etc. - * - * - `danger`: Used to show error, or dangerous message to the users. Used - * in custom container, badges, etc. - * -------------------------------------------------------------------------- */ - - :root { - --vp-c-default-1: var(--vp-c-gray-1); - --vp-c-default-2: var(--vp-c-gray-2); - --vp-c-default-3: var(--vp-c-gray-3); - --vp-c-default-soft: var(--vp-c-gray-soft); - - --vp-c-brand-1: var(--vp-c-indigo-1); - --vp-c-brand-2: var(--vp-c-indigo-2); - --vp-c-brand-3: var(--vp-c-indigo-3); - --vp-c-brand-soft: var(--vp-c-indigo-soft); - - --vp-c-tip-1: var(--vp-c-brand-1); - --vp-c-tip-2: var(--vp-c-brand-2); - --vp-c-tip-3: var(--vp-c-brand-3); - --vp-c-tip-soft: var(--vp-c-brand-soft); - - --vp-c-warning-1: var(--vp-c-yellow-1); - --vp-c-warning-2: var(--vp-c-yellow-2); - --vp-c-warning-3: var(--vp-c-yellow-3); - --vp-c-warning-soft: var(--vp-c-yellow-soft); - - --vp-c-danger-1: var(--vp-c-red-1); - --vp-c-danger-2: var(--vp-c-red-2); - --vp-c-danger-3: var(--vp-c-red-3); - --vp-c-danger-soft: var(--vp-c-red-soft); -} - -/** - * Component: Button - * -------------------------------------------------------------------------- */ - -:root { - --vp-button-brand-border: transparent; - --vp-button-brand-text: var(--vp-c-white); - --vp-button-brand-bg: var(--vp-c-brand-3); - --vp-button-brand-hover-border: transparent; - --vp-button-brand-hover-text: var(--vp-c-white); - --vp-button-brand-hover-bg: var(--vp-c-brand-2); - --vp-button-brand-active-border: transparent; - --vp-button-brand-active-text: var(--vp-c-white); - --vp-button-brand-active-bg: var(--vp-c-brand-1); -} - -/** - * Component: Home - * -------------------------------------------------------------------------- */ - -:root { - --vp-home-hero-name-color: transparent; - --vp-home-hero-name-background: -webkit-linear-gradient( - 120deg, - #bd34fe 30%, - #41d1ff - ); - - --vp-home-hero-image-background-image: linear-gradient( - -45deg, - #bd34fe 50%, - #47caff 50% - ); - --vp-home-hero-image-filter: blur(44px); -} - -@media (min-width: 640px) { - :root { - --vp-home-hero-image-filter: blur(56px); - } -} - -@media (min-width: 960px) { - :root { - --vp-home-hero-image-filter: blur(68px); - } -} - -/** - * Component: Custom Block - * -------------------------------------------------------------------------- */ - -:root { - --vp-custom-block-tip-border: transparent; - --vp-custom-block-tip-text: var(--vp-c-text-1); - --vp-custom-block-tip-bg: var(--vp-c-brand-soft); - --vp-custom-block-tip-code-bg: var(--vp-c-brand-soft); -} - -/** - * Component: Algolia - * -------------------------------------------------------------------------- */ - -.DocSearch { - --docsearch-primary-color: var(--vp-c-brand-1) !important; -} - diff --git a/docs/CLAUDE.md b/docs/CLAUDE.md index a106fa04..15ef561f 100644 --- a/docs/CLAUDE.md +++ b/docs/CLAUDE.md @@ -40,7 +40,6 @@ Applies are callback functions that the driver calls on LPC objects in response **Apply Documentation Template:** ```markdown --- -layout: doc title: category / apply_name --- # apply_name @@ -116,7 +115,6 @@ Efuns (external functions) are built-in C/C++ functions callable from LPC code. **Efun Documentation Template:** ```markdown --- -layout: doc title: category / efun_name --- # efun_name @@ -183,7 +181,6 @@ Command-line tools included with FluffOS. **CLI Documentation Template:** ```markdown --- -layout: doc title: cli / tool_name --- # cli / tool_name @@ -371,7 +368,6 @@ done **Front Matter:** ```yaml --- -layout: doc title: category / name --- ``` @@ -512,7 +508,7 @@ npm run dev # Visit http://localhost:3000 ``` -> **Note**: The `.vitepress/` directory is a leftover from a previous framework and can be ignored. +> **Note**: Leftovers from previous frameworks (VitePress `.vitepress/`, Jekyll `_layouts/` and `css/`) have been removed — everything is Docusaurus now. ### Sidebar Format diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..af23e8cc --- /dev/null +++ b/docs/README.md @@ -0,0 +1,89 @@ +# FluffOS Documentation + +This directory contains the source for the FluffOS documentation site, published at +[https://www.fluffos.info](https://www.fluffos.info). + +The site is built with **[Docusaurus 3](https://docusaurus.io/)** (`@docusaurus/preset-classic`). +Markdown files live directly in this directory (the docs plugin is configured with +`path: '.'` and `routeBasePath: '/'`), so `docs/efun/strings/explode.md` becomes +`/efun/strings/explode` on the site. + +> This README is for contributors and is excluded from the published site +> (see `exclude` in `docusaurus.config.ts`). + +## Local Development + +Requires Node.js 18+ (Node 22 recommended). + +```bash +cd docs +npm install +npm run dev # dev server on http://localhost:3000 +``` + +Other scripts: + +```bash +npm run build # production build → docs/build/ +npm run preview # serve the production build locally +npm run clear # clear the Docusaurus cache +``` + +## Search + +Full-text search is provided by +[`@easyops-cn/docusaurus-search-local`](https://github.com/easyops-cn/docusaurus-search-local), +an offline/local search theme — the index is generated at build time and shipped with the +site, so no external search service (e.g. Algolia) is needed. + +Notes: + +- The search index is only generated by `npm run build`. In the dev server + (`npm run dev`) the search bar shows a hint instead of results; use + `npm run build && npm run preview` to test search locally. +- Both English and Chinese (`zh-CN/`) pages are indexed (`language: ['en', 'zh']`). +- Search options live in the `themes` section of `docusaurus.config.ts`. + +## Layout + +| Path | Contents | +|------|----------| +| `docusaurus.config.ts` | Site config: navbar, footer, docs plugin, search theme | +| `sidebars.ts` | Sidebar navigation tree (Docusaurus `SidebarsConfig` format) | +| `src/css/custom.css` | Infima CSS variable overrides | +| `static/` | Files copied verbatim to the site root (`CNAME`, Google site verification) | +| `apply/` | Driver-to-LPC callback (apply) reference | +| `efun/` | Built-in function (efun) reference, by category | +| `stdlib/` | LPC standard-library reference | +| `driver/` | Driver internals & configuration | +| `lpc/` | LPC language reference | +| `concepts/` | High-level LPC / MUD concepts | +| `cli/` | Command-line tool docs | +| `zh-CN/` | Chinese documentation | +| `archive/` | Historical MudOS-era documents (not published) | + +### Maintenance scripts + +| Script | Purpose | +|--------|---------| +| `update_index.sh` | Regenerates all generated `index.md` listing pages (calls `gen_index.py`) | +| `gen_index.py` | Writes an `index.md` for one doc tree (e.g. `./gen_index.py efun EFUN`) | +| `gen_config_docs.py` | Regenerates `driver/config.md` from `src/base/internal/rc.cc` | +| `add_missing_efuns.py` | Creates stub pages under `efun/general/` for undocumented efuns (needs a `keywords.json` from the `generate_keywords` tool) | + +## Conventions & Gotchas + +- **`driver/config.md` is auto-generated** from `src/base/internal/rc.cc` — never edit it + by hand. Regenerate with `python3 docs/gen_config_docs.py`; CI fails if it is stale. +- `.md` files are treated as standard CommonMark (`markdown.format: 'detect'`), but bare + `{...}` in prose is still parsed as a JSX expression and breaks the build — escape it as + `\{...\}` outside fenced code blocks. +- Sidebar entries in `sidebars.ts` use doc IDs (relative path without extension), not URLs. +- Generated `index.md` listing pages (efun/apply/stdlib/cli/concepts/driver/zh-CN) are + rewritten by `./update_index.sh` — regenerate rather than hand-edit them. + `lpc/index.md` is hand-written and deliberately not regenerated. +- `onBrokenLinks` is set to `'throw'`: a broken internal link fails the build (and the + Pages deploy) instead of shipping a 404. + +See [`CLAUDE.md`](CLAUDE.md) for detailed documentation templates (applies, efuns, CLI +tools) and the full contribution workflow. diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html deleted file mode 100644 index 1463e446..00000000 --- a/docs/_layouts/default.html +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - FluffOS - {{ page.title }} - - - - - - - - - {% seo %} - - - -
-
-
-
- -
-
-
- -
- {{ content }} -
-
-
- -
-
-
-
- Improve this page -
-
-

Every page on this site is maintained by user like you!

- Edit On Github -
-
-
-
- - - - - - diff --git a/docs/add_missing_efuns.py b/docs/add_missing_efuns.py index a15d1417..17f9c5b1 100644 --- a/docs/add_missing_efuns.py +++ b/docs/add_missing_efuns.py @@ -1,11 +1,15 @@ #!/usr/bin/env python3 +"""Generate stub docs under efun/general/ for efuns that have no doc page. -# find all existing efuns through keywords.json, then generate doc under efun/general/ +Usage: add_missing_efuns.py path/to/keywords.json + +keywords.json is produced by the generate_keywords tool from a compiled +driver (run it in your build directory). Run this script from docs/. +""" -import os import json - -EFUNS_DOCS = set() +import os +import sys def generate_signature(efun): @@ -17,7 +21,6 @@ def generate_signature(efun): def generate_doc(efun): return f"""--- -layout: doc title: general / {efun["name"]} --- # {efun["name"]} @@ -38,27 +41,26 @@ title: general / {efun["name"]} def main(): + if len(sys.argv) != 2 or not os.path.isfile(sys.argv[1]): + sys.exit(__doc__.strip().splitlines()[2]) # the Usage line + + documented = set() for root, dirs, files in os.walk("./efun"): for file in files: - if file.endswith(".md"): - if file == "index.md": - continue - EFUNS_DOCS.add(file[:-3]) - print("EFUNS with docs: " + str(len(EFUNS_DOCS))) + if file.endswith(".md") and file != "index.md": + documented.add(file[:-3]) + print(f"EFUNS with docs: {len(documented)}") - keywords = json.load(open("./keywords.json")) + keywords = json.load(open(sys.argv[1])) all_efuns = {keyword["name"]: keyword for keyword in keywords} - print("ALL EFUNS: " + str(len(all_efuns))) + print(f"ALL EFUNS: {len(all_efuns)}") - for efun in all_efuns: - if efun.startswith("_"): + for name, efun in all_efuns.items(): + if name.startswith("_") or name in documented: continue - if efun in EFUNS_DOCS: - continue - print(f"Generating doc for {efun}") - content = generate_doc(all_efuns[efun]) - with open(f"./efun/general/{efun}.md", "w") as f: - f.write(content) + print(f"Generating doc for {name}") + with open(f"./efun/general/{name}.md", "w") as f: + f.write(generate_doc(efun)) if __name__ == "__main__": diff --git a/docs/apply/index.md b/docs/apply/index.md index 0c6ee525..25c28d05 100644 --- a/docs/apply/index.md +++ b/docs/apply/index.md @@ -1,5 +1,4 @@ --- -layout: doc title: APPLY --- ## interactive diff --git a/docs/apply/interactive/catch_tell.md b/docs/apply/interactive/catch_tell.md index 38935def..83497d84 100644 --- a/docs/apply/interactive/catch_tell.md +++ b/docs/apply/interactive/catch_tell.md @@ -1,5 +1,4 @@ --- -layout: doc title: interactive / catch_tell --- # catch_tell diff --git a/docs/apply/interactive/gmcp.md b/docs/apply/interactive/gmcp.md index 8c199e56..2d18922e 100644 --- a/docs/apply/interactive/gmcp.md +++ b/docs/apply/interactive/gmcp.md @@ -1,5 +1,4 @@ --- -layout: doc title: interactive / gmcp --- # gmcp diff --git a/docs/apply/interactive/gmcp_enable.md b/docs/apply/interactive/gmcp_enable.md index b8edeeef..ce57aac6 100644 --- a/docs/apply/interactive/gmcp_enable.md +++ b/docs/apply/interactive/gmcp_enable.md @@ -1,5 +1,4 @@ --- -layout: doc title: interactive / gmcp_enable --- # gmcp_enable diff --git a/docs/apply/interactive/index.md b/docs/apply/interactive/index.md index fc946da2..b4e2b146 100644 --- a/docs/apply/interactive/index.md +++ b/docs/apply/interactive/index.md @@ -1,5 +1,4 @@ --- -layout: doc title: interactive --- * [catch_tell](catch_tell) diff --git a/docs/apply/interactive/logon.md b/docs/apply/interactive/logon.md index b9268a82..8833c5ed 100644 --- a/docs/apply/interactive/logon.md +++ b/docs/apply/interactive/logon.md @@ -1,5 +1,4 @@ --- -layout: doc title: interactive / logon --- # logon diff --git a/docs/apply/interactive/msdp.md b/docs/apply/interactive/msdp.md index 7858e198..65b677f7 100644 --- a/docs/apply/interactive/msdp.md +++ b/docs/apply/interactive/msdp.md @@ -1,5 +1,4 @@ --- -layout: doc title: interactive / msdp --- # gmcp diff --git a/docs/apply/interactive/msdp_enable.md b/docs/apply/interactive/msdp_enable.md index 96b1d66a..72551899 100644 --- a/docs/apply/interactive/msdp_enable.md +++ b/docs/apply/interactive/msdp_enable.md @@ -1,5 +1,4 @@ --- -layout: doc title: interactive / msdp_enable --- # msdp_enable diff --git a/docs/apply/interactive/msp_enable.md b/docs/apply/interactive/msp_enable.md index cfdc4f89..dbf669ec 100644 --- a/docs/apply/interactive/msp_enable.md +++ b/docs/apply/interactive/msp_enable.md @@ -1,5 +1,4 @@ --- -layout: doc title: interactive / msp_enable --- # msp_enable diff --git a/docs/apply/interactive/mxp_enable.md b/docs/apply/interactive/mxp_enable.md index 4bb5f5a5..92717434 100644 --- a/docs/apply/interactive/mxp_enable.md +++ b/docs/apply/interactive/mxp_enable.md @@ -1,5 +1,4 @@ --- -layout: doc title: interactive / mxp_enable --- # mxp_enable diff --git a/docs/apply/interactive/mxp_tag.md b/docs/apply/interactive/mxp_tag.md index a284059d..fd9ae04e 100644 --- a/docs/apply/interactive/mxp_tag.md +++ b/docs/apply/interactive/mxp_tag.md @@ -1,5 +1,4 @@ --- -layout: doc title: interactive / mxp_tag --- # mxp_tag diff --git a/docs/apply/interactive/net_dead.md b/docs/apply/interactive/net_dead.md index c25aab7e..6fbdaf70 100644 --- a/docs/apply/interactive/net_dead.md +++ b/docs/apply/interactive/net_dead.md @@ -1,5 +1,4 @@ --- -layout: doc title: interactive / net_dead --- # net_dead diff --git a/docs/apply/interactive/process_input.md b/docs/apply/interactive/process_input.md index 1603d685..5aead261 100644 --- a/docs/apply/interactive/process_input.md +++ b/docs/apply/interactive/process_input.md @@ -1,5 +1,4 @@ --- -layout: doc title: interactive / process_input --- # process_input diff --git a/docs/apply/interactive/receive_ed.md b/docs/apply/interactive/receive_ed.md index 2bb67c1a..e6bdc564 100644 --- a/docs/apply/interactive/receive_ed.md +++ b/docs/apply/interactive/receive_ed.md @@ -1,5 +1,4 @@ --- -layout: doc title: interactive / receive_ed --- # receive_ed diff --git a/docs/apply/interactive/receive_environ.md b/docs/apply/interactive/receive_environ.md index a45411a2..9946ffc1 100644 --- a/docs/apply/interactive/receive_environ.md +++ b/docs/apply/interactive/receive_environ.md @@ -1,5 +1,4 @@ --- -layout: doc title: apply / interactive / receive_environ --- # receive_environ diff --git a/docs/apply/interactive/receive_message.md b/docs/apply/interactive/receive_message.md index 3f73239c..885e6f47 100644 --- a/docs/apply/interactive/receive_message.md +++ b/docs/apply/interactive/receive_message.md @@ -1,5 +1,4 @@ --- -layout: doc title: apply / interactive / receive_message --- # receive_message diff --git a/docs/apply/interactive/receive_snoop.md b/docs/apply/interactive/receive_snoop.md index 0ade9ab7..477c97bf 100644 --- a/docs/apply/interactive/receive_snoop.md +++ b/docs/apply/interactive/receive_snoop.md @@ -1,5 +1,4 @@ --- -layout: doc title: interactive / receive_snoop --- # receive_snoop diff --git a/docs/apply/interactive/telnet_suboption.md b/docs/apply/interactive/telnet_suboption.md index a2a777f2..dab53cb3 100644 --- a/docs/apply/interactive/telnet_suboption.md +++ b/docs/apply/interactive/telnet_suboption.md @@ -1,5 +1,4 @@ --- -layout: doc title: interactive / telnet_suboption --- # telnet_suboption diff --git a/docs/apply/interactive/terminal_colour_replace.md b/docs/apply/interactive/terminal_colour_replace.md index 18dc6a49..ae1fd63f 100644 --- a/docs/apply/interactive/terminal_colour_replace.md +++ b/docs/apply/interactive/terminal_colour_replace.md @@ -1,5 +1,4 @@ --- -layout: doc title: interactive / terminal_colour_replace --- # terminal_colour_replace diff --git a/docs/apply/interactive/terminal_type.md b/docs/apply/interactive/terminal_type.md index 7d131080..57d7c240 100644 --- a/docs/apply/interactive/terminal_type.md +++ b/docs/apply/interactive/terminal_type.md @@ -1,5 +1,4 @@ --- -layout: doc title: interactive / terminal_type --- # terminal_type diff --git a/docs/apply/interactive/window_size.md b/docs/apply/interactive/window_size.md index d6625e2a..00478247 100644 --- a/docs/apply/interactive/window_size.md +++ b/docs/apply/interactive/window_size.md @@ -1,5 +1,4 @@ --- -layout: doc title: interactive / window_size --- # window_size diff --git a/docs/apply/interactive/write_prompt.md b/docs/apply/interactive/write_prompt.md index aab7d866..462dfaa2 100644 --- a/docs/apply/interactive/write_prompt.md +++ b/docs/apply/interactive/write_prompt.md @@ -1,5 +1,4 @@ --- -layout: doc title: interactive / write_prompt --- # write_prompt diff --git a/docs/apply/interactive/zmp.md b/docs/apply/interactive/zmp.md index a268cb26..104b9ace 100644 --- a/docs/apply/interactive/zmp.md +++ b/docs/apply/interactive/zmp.md @@ -1,5 +1,4 @@ --- -layout: doc title: interactive / zmp --- # zmp_command diff --git a/docs/apply/master/author_file.md b/docs/apply/master/author_file.md index 553963bd..d38fd86e 100644 --- a/docs/apply/master/author_file.md +++ b/docs/apply/master/author_file.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / author_file --- # author_file diff --git a/docs/apply/master/compile_object.md b/docs/apply/master/compile_object.md index 2cfe9081..061b5471 100644 --- a/docs/apply/master/compile_object.md +++ b/docs/apply/master/compile_object.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / compile_object --- # compile_object diff --git a/docs/apply/master/connect.md b/docs/apply/master/connect.md index ff287db6..323627ea 100644 --- a/docs/apply/master/connect.md +++ b/docs/apply/master/connect.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / connect --- # connect diff --git a/docs/apply/master/crash.md b/docs/apply/master/crash.md index 3a61a298..bfca155f 100644 --- a/docs/apply/master/crash.md +++ b/docs/apply/master/crash.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / crash --- # crash diff --git a/docs/apply/master/creator_file.md b/docs/apply/master/creator_file.md index 977ff137..538de03a 100644 --- a/docs/apply/master/creator_file.md +++ b/docs/apply/master/creator_file.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / creator_file --- # creator_file diff --git a/docs/apply/master/domain_file.md b/docs/apply/master/domain_file.md index 6887bff5..b3478467 100644 --- a/docs/apply/master/domain_file.md +++ b/docs/apply/master/domain_file.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / domain_file --- # domain_file diff --git a/docs/apply/master/epilog.md b/docs/apply/master/epilog.md index 0bc84714..1f22e744 100644 --- a/docs/apply/master/epilog.md +++ b/docs/apply/master/epilog.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / epilog --- # epilog diff --git a/docs/apply/master/error_handler.md b/docs/apply/master/error_handler.md index 40830e3b..7f336c1c 100644 --- a/docs/apply/master/error_handler.md +++ b/docs/apply/master/error_handler.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / error_handler --- # error_handler diff --git a/docs/apply/master/flag.md b/docs/apply/master/flag.md index 6d5aa5f3..dc75fcb7 100644 --- a/docs/apply/master/flag.md +++ b/docs/apply/master/flag.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / flag --- # flag diff --git a/docs/apply/master/get_bb_uid.md b/docs/apply/master/get_bb_uid.md index 09384434..a1394324 100644 --- a/docs/apply/master/get_bb_uid.md +++ b/docs/apply/master/get_bb_uid.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / get_bb_uid --- # get_bb_uid diff --git a/docs/apply/master/get_include_path.md b/docs/apply/master/get_include_path.md index fcddfe2a..25f17678 100644 --- a/docs/apply/master/get_include_path.md +++ b/docs/apply/master/get_include_path.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / get_include_path --- # get_include_path diff --git a/docs/apply/master/get_mud_stats.md b/docs/apply/master/get_mud_stats.md index 2bcbea8d..b75683de 100644 --- a/docs/apply/master/get_mud_stats.md +++ b/docs/apply/master/get_mud_stats.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / get_mud_stats --- # get_mud_stats diff --git a/docs/apply/master/get_root_uid.md b/docs/apply/master/get_root_uid.md index bef7fef0..e5e0c363 100644 --- a/docs/apply/master/get_root_uid.md +++ b/docs/apply/master/get_root_uid.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / get_root_uid --- # get_root_uid diff --git a/docs/apply/master/get_save_file_name.md b/docs/apply/master/get_save_file_name.md index ecfb615d..a76054a8 100644 --- a/docs/apply/master/get_save_file_name.md +++ b/docs/apply/master/get_save_file_name.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / get_save_file_name --- # get_save_file_name diff --git a/docs/apply/master/index.md b/docs/apply/master/index.md index f2913ed5..66a77448 100644 --- a/docs/apply/master/index.md +++ b/docs/apply/master/index.md @@ -1,5 +1,4 @@ --- -layout: doc title: master --- * [author_file](author_file) diff --git a/docs/apply/master/log_error.md b/docs/apply/master/log_error.md index c5d7e507..dec9427b 100644 --- a/docs/apply/master/log_error.md +++ b/docs/apply/master/log_error.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / log_error --- # log_error diff --git a/docs/apply/master/make_path_absolute.md b/docs/apply/master/make_path_absolute.md index 177831e6..07912a63 100644 --- a/docs/apply/master/make_path_absolute.md +++ b/docs/apply/master/make_path_absolute.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / make_path_absolute --- # make_path_absolute diff --git a/docs/apply/master/object_name.md b/docs/apply/master/object_name.md index 4b6ef528..6bfbf3c0 100644 --- a/docs/apply/master/object_name.md +++ b/docs/apply/master/object_name.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / object_name --- # object_name diff --git a/docs/apply/master/parser_error_message.md b/docs/apply/master/parser_error_message.md index e86ca1aa..6d1742d9 100644 --- a/docs/apply/master/parser_error_message.md +++ b/docs/apply/master/parser_error_message.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / parser_error_message --- # parser_error_message diff --git a/docs/apply/master/preload.md b/docs/apply/master/preload.md index d3b64ec8..906221df 100644 --- a/docs/apply/master/preload.md +++ b/docs/apply/master/preload.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / preload --- # preload diff --git a/docs/apply/master/privs_file.md b/docs/apply/master/privs_file.md index cddffdbc..782b518d 100644 --- a/docs/apply/master/privs_file.md +++ b/docs/apply/master/privs_file.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / privs_file --- # privs_file diff --git a/docs/apply/master/retrieve_ed_setup.md b/docs/apply/master/retrieve_ed_setup.md index b45ea034..fabc5d42 100644 --- a/docs/apply/master/retrieve_ed_setup.md +++ b/docs/apply/master/retrieve_ed_setup.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / retrieve_ed_setup --- # retrieve_ed_setup diff --git a/docs/apply/master/save_ed_setup.md b/docs/apply/master/save_ed_setup.md index 6af5a19c..e2120d18 100644 --- a/docs/apply/master/save_ed_setup.md +++ b/docs/apply/master/save_ed_setup.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / save_ed_setup --- # save_ed_setup diff --git a/docs/apply/master/valid_bind.md b/docs/apply/master/valid_bind.md index 10762061..5263ef48 100644 --- a/docs/apply/master/valid_bind.md +++ b/docs/apply/master/valid_bind.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / valid_bind --- # valid_bind diff --git a/docs/apply/master/valid_database.md b/docs/apply/master/valid_database.md index 7521cd16..1c83a314 100644 --- a/docs/apply/master/valid_database.md +++ b/docs/apply/master/valid_database.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / valid_database --- # valid_database diff --git a/docs/apply/master/valid_hide.md b/docs/apply/master/valid_hide.md index 2965726f..89293d2d 100644 --- a/docs/apply/master/valid_hide.md +++ b/docs/apply/master/valid_hide.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / valid_hide --- # valid_hide diff --git a/docs/apply/master/valid_link.md b/docs/apply/master/valid_link.md index c34ff905..85f4f914 100644 --- a/docs/apply/master/valid_link.md +++ b/docs/apply/master/valid_link.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / valid_link --- # valid_link diff --git a/docs/apply/master/valid_object.md b/docs/apply/master/valid_object.md index bf14fbf0..6665a5f1 100644 --- a/docs/apply/master/valid_object.md +++ b/docs/apply/master/valid_object.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / valid_object --- # valid_object diff --git a/docs/apply/master/valid_override.md b/docs/apply/master/valid_override.md index a1f7078c..ae86c371 100644 --- a/docs/apply/master/valid_override.md +++ b/docs/apply/master/valid_override.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / valid_override --- # valid_override diff --git a/docs/apply/master/valid_read.md b/docs/apply/master/valid_read.md index 0be64b32..6934a647 100644 --- a/docs/apply/master/valid_read.md +++ b/docs/apply/master/valid_read.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / valid_read --- # valid_read diff --git a/docs/apply/master/valid_save_binary.md b/docs/apply/master/valid_save_binary.md index e94dcb0c..2d993b1c 100644 --- a/docs/apply/master/valid_save_binary.md +++ b/docs/apply/master/valid_save_binary.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / valid_save_binary --- # valid_save_binary diff --git a/docs/apply/master/valid_seteuid.md b/docs/apply/master/valid_seteuid.md index 438d4d3d..0836aeb1 100644 --- a/docs/apply/master/valid_seteuid.md +++ b/docs/apply/master/valid_seteuid.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / valid_seteuid --- # valid_seteuid diff --git a/docs/apply/master/valid_shadow.md b/docs/apply/master/valid_shadow.md index d0c1a21b..0c567ffe 100644 --- a/docs/apply/master/valid_shadow.md +++ b/docs/apply/master/valid_shadow.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / valid_shadow --- # valid_shadow diff --git a/docs/apply/master/valid_socket.md b/docs/apply/master/valid_socket.md index 81ea80c8..d2e850fb 100644 --- a/docs/apply/master/valid_socket.md +++ b/docs/apply/master/valid_socket.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / valid_socket --- # valid_socket diff --git a/docs/apply/master/valid_write.md b/docs/apply/master/valid_write.md index 8a1a6027..ce7d3b59 100644 --- a/docs/apply/master/valid_write.md +++ b/docs/apply/master/valid_write.md @@ -1,5 +1,4 @@ --- -layout: doc title: master / valid_write --- # valid_write diff --git a/docs/apply/object/__INIT.md b/docs/apply/object/__INIT.md index 064222e4..cc87260a 100644 --- a/docs/apply/object/__INIT.md +++ b/docs/apply/object/__INIT.md @@ -1,5 +1,4 @@ --- -layout: doc title: object / __INIT --- # __INIT diff --git a/docs/apply/object/clean_up.md b/docs/apply/object/clean_up.md index f8b1122a..450cdf21 100644 --- a/docs/apply/object/clean_up.md +++ b/docs/apply/object/clean_up.md @@ -1,5 +1,4 @@ --- -layout: doc title: object / clean_up --- # clean_up diff --git a/docs/apply/object/create.md b/docs/apply/object/create.md index 2b066868..7883b33d 100644 --- a/docs/apply/object/create.md +++ b/docs/apply/object/create.md @@ -1,5 +1,4 @@ --- -layout: doc title: object / create --- # create diff --git a/docs/apply/object/heart_beat.md b/docs/apply/object/heart_beat.md index e914f873..998f3f31 100644 --- a/docs/apply/object/heart_beat.md +++ b/docs/apply/object/heart_beat.md @@ -1,5 +1,4 @@ --- -layout: doc title: object / heart_beat --- # heart_beat diff --git a/docs/apply/object/id.md b/docs/apply/object/id.md index 28b4e4d3..6207b5e8 100644 --- a/docs/apply/object/id.md +++ b/docs/apply/object/id.md @@ -1,5 +1,4 @@ --- -layout: doc title: object / id --- # id diff --git a/docs/apply/object/index.md b/docs/apply/object/index.md index 9b60d969..852b60e7 100644 --- a/docs/apply/object/index.md +++ b/docs/apply/object/index.md @@ -1,5 +1,4 @@ --- -layout: doc title: object --- * [__INIT](__INIT) diff --git a/docs/apply/object/init.md b/docs/apply/object/init.md index e48b91be..08aa3ba1 100644 --- a/docs/apply/object/init.md +++ b/docs/apply/object/init.md @@ -1,5 +1,4 @@ --- -layout: doc title: object / init --- # init diff --git a/docs/apply/object/is_living.md b/docs/apply/object/is_living.md index c2076566..e5ecb8f8 100644 --- a/docs/apply/object/is_living.md +++ b/docs/apply/object/is_living.md @@ -1,5 +1,4 @@ --- -layout: doc title: object / is_living --- # is_living diff --git a/docs/apply/object/move_or_destruct.md b/docs/apply/object/move_or_destruct.md index a20fa2bb..1463cd2f 100644 --- a/docs/apply/object/move_or_destruct.md +++ b/docs/apply/object/move_or_destruct.md @@ -1,5 +1,4 @@ --- -layout: doc title: object / move_or_destruct --- # move_or_destruct diff --git a/docs/apply/object/on_destruct.md b/docs/apply/object/on_destruct.md index cabd77ae..663aed49 100644 --- a/docs/apply/object/on_destruct.md +++ b/docs/apply/object/on_destruct.md @@ -1,5 +1,4 @@ --- -layout: doc title: object / on_destruct --- # on_destruct diff --git a/docs/apply/object/reset.md b/docs/apply/object/reset.md index 9447d3a9..6db3ef85 100644 --- a/docs/apply/object/reset.md +++ b/docs/apply/object/reset.md @@ -1,5 +1,4 @@ --- -layout: doc title: object / reset --- # reset diff --git a/docs/apply/object/virtual_start.md b/docs/apply/object/virtual_start.md index 801400e4..e876943f 100644 --- a/docs/apply/object/virtual_start.md +++ b/docs/apply/object/virtual_start.md @@ -1,5 +1,4 @@ --- -layout: doc title: object / virtual_start --- # virtual_start diff --git a/docs/bug.md b/docs/bug.md index d3ab80dc..f82f6bbd 100644 --- a/docs/bug.md +++ b/docs/bug.md @@ -1,5 +1,4 @@ --- -layout: doc title: Troubleshooting --- # Troubleshooting diff --git a/docs/build.md b/docs/build.md index 662b43e4..7d3df152 100644 --- a/docs/build.md +++ b/docs/build.md @@ -1,5 +1,4 @@ --- -layout: doc title: Build --- diff --git a/docs/build_v2017.md b/docs/build_v2017.md index 1e7c3202..ce15c274 100644 --- a/docs/build_v2017.md +++ b/docs/build_v2017.md @@ -1,5 +1,4 @@ --- -layout: doc title: Build (v2017) --- # build_v2017 diff --git a/docs/cli/driver.md b/docs/cli/driver.md index 6c2e003c..9031f88b 100644 --- a/docs/cli/driver.md +++ b/docs/cli/driver.md @@ -1,5 +1,4 @@ --- -layout: doc title: cli / driver --- # cli / driver diff --git a/docs/cli/generate_keywords.md b/docs/cli/generate_keywords.md index 97960a67..1aec5123 100644 --- a/docs/cli/generate_keywords.md +++ b/docs/cli/generate_keywords.md @@ -1,5 +1,4 @@ --- -layout: doc title: cli / generate_keywords --- # cli / generate_keywords diff --git a/docs/cli/index.md b/docs/cli/index.md index 318ff126..8d0a712f 100644 --- a/docs/cli/index.md +++ b/docs/cli/index.md @@ -1,5 +1,4 @@ --- -layout: doc title: cli --- * [driver](driver) diff --git a/docs/cli/json2o.md b/docs/cli/json2o.md index 0e6b1f44..10f7b6eb 100644 --- a/docs/cli/json2o.md +++ b/docs/cli/json2o.md @@ -1,5 +1,4 @@ --- -layout: doc title: cli / json2o --- diff --git a/docs/cli/lpcc.md b/docs/cli/lpcc.md index 85035a2b..733b52db 100644 --- a/docs/cli/lpcc.md +++ b/docs/cli/lpcc.md @@ -1,5 +1,4 @@ --- -layout: doc title: cli / lpcc --- diff --git a/docs/cli/o2json.md b/docs/cli/o2json.md index cc9e0e38..61c1fe29 100644 --- a/docs/cli/o2json.md +++ b/docs/cli/o2json.md @@ -1,5 +1,4 @@ --- -layout: doc title: cli / o2json --- diff --git a/docs/cli/portbind.md b/docs/cli/portbind.md index ba4620e6..e4524374 100644 --- a/docs/cli/portbind.md +++ b/docs/cli/portbind.md @@ -1,5 +1,4 @@ --- -layout: doc title: cli / portbind --- # cli / portbind diff --git a/docs/cli/symbol.md b/docs/cli/symbol.md index 6b83b3e5..b4eaf3e2 100644 --- a/docs/cli/symbol.md +++ b/docs/cli/symbol.md @@ -1,5 +1,4 @@ --- -layout: doc title: cli / symbol --- # cli / symbol diff --git a/docs/concepts/general/fluffos_driver.md b/docs/concepts/general/fluffos_driver.md index a2918e0a..a9a6e5bf 100644 --- a/docs/concepts/general/fluffos_driver.md +++ b/docs/concepts/general/fluffos_driver.md @@ -1,5 +1,4 @@ --- -layout: doc title: general / FluffOS driver --- # The FluffOS driver diff --git a/docs/concepts/general/global_include_file.md b/docs/concepts/general/global_include_file.md index 7380d84a..a9862641 100644 --- a/docs/concepts/general/global_include_file.md +++ b/docs/concepts/general/global_include_file.md @@ -1,5 +1,4 @@ --- -layout: doc title: general / global_include_file --- # global_include_file diff --git a/docs/concepts/general/index.md b/docs/concepts/general/index.md index c42b9a41..b1f1b384 100644 --- a/docs/concepts/general/index.md +++ b/docs/concepts/general/index.md @@ -1,5 +1,4 @@ --- -layout: doc title: general --- * [fluffos_driver](fluffos_driver) diff --git a/docs/concepts/general/lpc.md b/docs/concepts/general/lpc.md index 4b256eb5..34e2441e 100644 --- a/docs/concepts/general/lpc.md +++ b/docs/concepts/general/lpc.md @@ -1,5 +1,4 @@ --- -layout: doc title: general / lpc --- # lpc diff --git a/docs/concepts/general/message_doc.md b/docs/concepts/general/message_doc.md index a68050ed..676ed16a 100644 --- a/docs/concepts/general/message_doc.md +++ b/docs/concepts/general/message_doc.md @@ -1,5 +1,4 @@ --- -layout: doc title: general / message_doc --- # message_doc diff --git a/docs/concepts/general/objects.md b/docs/concepts/general/objects.md index 1d124036..af08f79f 100644 --- a/docs/concepts/general/objects.md +++ b/docs/concepts/general/objects.md @@ -1,5 +1,4 @@ --- -layout: doc title: general / objects --- # objects diff --git a/docs/concepts/general/oop.md b/docs/concepts/general/oop.md index 419cb162..27c1d31d 100644 --- a/docs/concepts/general/oop.md +++ b/docs/concepts/general/oop.md @@ -1,5 +1,4 @@ --- -layout: doc title: general / oop --- # oop diff --git a/docs/concepts/general/preprocessor.md b/docs/concepts/general/preprocessor.md index 791792f9..6abf580d 100644 --- a/docs/concepts/general/preprocessor.md +++ b/docs/concepts/general/preprocessor.md @@ -1,5 +1,4 @@ --- -layout: doc title: general / preprocessor --- # preprocessor diff --git a/docs/concepts/general/simul_efun.md b/docs/concepts/general/simul_efun.md index 8858ec89..47336005 100644 --- a/docs/concepts/general/simul_efun.md +++ b/docs/concepts/general/simul_efun.md @@ -1,5 +1,4 @@ --- -layout: doc title: general / simul_efun --- # simul_efun diff --git a/docs/concepts/general/socket_efuns.md b/docs/concepts/general/socket_efuns.md index 73e62c7d..d8ef6e48 100644 --- a/docs/concepts/general/socket_efuns.md +++ b/docs/concepts/general/socket_efuns.md @@ -1,5 +1,4 @@ --- -layout: doc title: general / socket_efuns --- # socket_efuns diff --git a/docs/concepts/general/tls.md b/docs/concepts/general/tls.md index fad3b55a..f18098fa 100644 --- a/docs/concepts/general/tls.md +++ b/docs/concepts/general/tls.md @@ -1,5 +1,4 @@ --- -layout: doc title: TLS/SSL Support --- # TLS/SSL Support diff --git a/docs/concepts/general/tracing.md b/docs/concepts/general/tracing.md index cbe6e256..88761b62 100644 --- a/docs/concepts/general/tracing.md +++ b/docs/concepts/general/tracing.md @@ -1,5 +1,4 @@ --- -layout: doc title: Tracing and Performance Profiling --- # Tracing and Performance Profiling diff --git a/docs/concepts/general/websocket.md b/docs/concepts/general/websocket.md index f236ab13..86d22f66 100644 --- a/docs/concepts/general/websocket.md +++ b/docs/concepts/general/websocket.md @@ -1,5 +1,4 @@ --- -layout: doc title: WebSocket Support --- # WebSocket Support diff --git a/docs/concepts/index.md b/docs/concepts/index.md index 8ae2a702..773233ef 100644 --- a/docs/concepts/index.md +++ b/docs/concepts/index.md @@ -1,5 +1,4 @@ --- -layout: doc title: concepts --- ## general diff --git a/docs/css/default.css b/docs/css/default.css deleted file mode 100644 index f0b3b330..00000000 --- a/docs/css/default.css +++ /dev/null @@ -1,56 +0,0 @@ -.blog-header { - line-height: 1; -} - -.blog-header-logo { - font-family: "Playfair Display", Georgia, "Times New Roman", serif; - font-size: 2.25rem; -} - -.blog-header-logo:hover { - text-decoration: none; -} - -h1, h2, h3, h4, h5, h6 { - font-family: "Playfair Display", Georgia, "Times New Roman", serif; -} - - -#pages { - text-align: left; - border-right: 1px solid #ccc; - padding-right: 2em; -} -#pages ol { - list-style: none; - padding: 0; - margin: 0; -} -#pages ol li { - padding: 0.3em 0 0.6em 0em; - color: #669966; - font-weight: bold; -} -#pages ol li ol { - margin-top: 0.3em; - padding: 0.3em 0 0.9em 0.9em; -} -#pages ol li ol li { - padding: 0.3em 0 0.3em 0em; -} -#pages ol li a { - font-weight: normal; -} -#pages form { - margin-top: 2em; - padding: 0.3em 0 0.5em 0.5em; -} -#pages ol li p { - font-weight: normal; - color: #000; - vertical-align: center; -} - -#content p img { - max-width: 100%; -} diff --git a/docs/css/rouge.css b/docs/css/rouge.css deleted file mode 100644 index 6fd335fb..00000000 --- a/docs/css/rouge.css +++ /dev/null @@ -1,196 +0,0 @@ -.highlight table td { padding: 5px; } -.highlight table pre { margin: 0; } -.highlight .gh { - color: #999999; -} -.highlight .sr { - color: #f6aa11; -} -.highlight .go { - color: #888888; -} -.highlight .gp { - color: #555555; -} -.highlight .gs { - color: #75715e; -} -.highlight .gu { - color: #aaaaaa; -} -.highlight .nb { - color: #f6aa11; -} -.highlight .cm { - color: #75715e; -} -.highlight .cp { - color: #75715e; -} -.highlight .c1 { - color: #75715e; -} -.highlight .cs { - color: #75715e; -} -.highlight .c, .highlight .cd { - color: #75715e; -} -.highlight .err { - color: #960050; -} -.highlight .gr { - color: #960050; -} -.highlight .gt { - color: #960050; -} -.highlight .gd { - color: #49483e; -} -.highlight .gi { - color: #49483e; -} -.highlight .ge { - color: #49483e; -} -.highlight .kc { - color: #66d9ef; -} -.highlight .kd { - color: #66d9ef; -} -.highlight .kr { - color: #66d9ef; -} -.highlight .no { - color: #66d9ef; -} -.highlight .kt { - color: #66d9ef; -} -.highlight .mf { - color: #ae81ff; -} -.highlight .mh { - color: #ae81ff; -} -.highlight .il { - color: #ae81ff; -} -.highlight .mi { - color: #ae81ff; -} -.highlight .mo { - color: #ae81ff; -} -.highlight .m, .highlight .mb, .highlight .mx { - color: #ae81ff; -} -.highlight .sc { - color: #ae81ff; -} -.highlight .se { - color: #ae81ff; -} -.highlight .ss { - color: #ae81ff; -} -.highlight .sd { - color: #e6db74; -} -.highlight .s2 { - color: #e6db74; -} -.highlight .sb { - color: #e6db74; -} -.highlight .sh { - color: #e6db74; -} -.highlight .si { - color: #e6db74; -} -.highlight .sx { - color: #e6db74; -} -.highlight .s1 { - color: #e6db74; -} -.highlight .s { - color: #e6db74; -} -.highlight .na { - color: #a6e22e; -} -.highlight .nc { - color: #a6e22e; -} -.highlight .nd { - color: #a6e22e; -} -.highlight .ne { - color: #a6e22e; -} -.highlight .nf { - color: #a6e22e; -} -.highlight .vc { - color: #ffffff; -} -.highlight .nn { - color: #ffffff; -} -.highlight .nl { - color: #ffffff; -} -.highlight .ni { - color: #ffffff; -} -.highlight .bp { - color: #ffffff; -} -.highlight .vg { - color: #ffffff; -} -.highlight .vi { - color: #ffffff; -} -.highlight .nv { - color: #ffffff; -} -.highlight .w { - color: #ffffff; -} -.highlight { - color: #ffffff; -} -.highlight .n, .highlight .py, .highlight .nx { - color: #ffffff; -} -.highlight .ow { - color: #f92672; -} -.highlight .nt { - color: #f92672; -} -.highlight .k, .highlight .kv { - color: #f92672; -} -.highlight .kn { - color: #f92672; -} -.highlight .kp { - color: #f92672; -} -.highlight .o { - color: #f92672; -} - -div[class="highlight"] > pre { - background: #384548; - padding: 2em; - white-space: pre-wrap; - word-wrap: break-word; - text-align: left; -} diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index c7e5fb7c..161486c6 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -10,7 +10,7 @@ const config: Config = { baseUrl: '/', organizationName: 'fluffos', projectName: 'fluffos', - onBrokenLinks: 'warn', + onBrokenLinks: 'throw', i18n: { defaultLocale: 'en', @@ -36,11 +36,9 @@ const config: Config = { editUrl: 'https://github.com/fluffos/fluffos/edit/master/docs/', exclude: [ '**/node_modules/**', - '**/.vitepress/**', '**/archive/**', - '**/forum_posts/**', - '_layouts/**', 'CLAUDE.md', + 'README.md', ], }, blog: false, @@ -51,6 +49,24 @@ const config: Config = { ], ], + themes: [ + [ + '@easyops-cn/docusaurus-search-local', + { + // offline/local search — no external service required + hashed: true, + indexBlog: false, + // docs live in this directory and are served from the site root + docsDir: '.', + docsRouteBasePath: '/', + // English docs plus the zh-CN pages + language: ['en', 'zh'], + highlightSearchTermsOnTargetPage: true, + explicitSearchResultPath: true, + }, + ], + ], + themeConfig: { navbar: { title: 'FluffOS', diff --git a/docs/driver/adding_efuns.md b/docs/driver/adding_efuns.md index 213b70f3..50b6f30f 100644 --- a/docs/driver/adding_efuns.md +++ b/docs/driver/adding_efuns.md @@ -1,5 +1,4 @@ --- -layout: doc title: general / adding_efuns --- # adding_efuns diff --git a/docs/driver/call_into_vm.md b/docs/driver/call_into_vm.md index ea704c1c..9202ae79 100644 --- a/docs/driver/call_into_vm.md +++ b/docs/driver/call_into_vm.md @@ -1,5 +1,4 @@ --- -layout: doc title: general / call_into_vm --- # call_into_vm diff --git a/docs/driver/config.md b/docs/driver/config.md index 5413ff61..94eb2789 100644 --- a/docs/driver/config.md +++ b/docs/driver/config.md @@ -1,5 +1,4 @@ --- -layout: doc title: driver / config ---