@markdownspace/site-generator 1.0.0

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2024-2026 Devon Bradley and the markdown.space contributors
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
+SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
+IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,85 @@
+# Markdown Space Site Generator
+
+Turn markdown / MDX documents into complete, styled websites. This is the
+site generation engine behind [markdown.space](https://markdown.space) — it
+renders markdown with YAML frontmatter into full HTML pages with Bootstrap or
+Bulma themes, navbars, syntax highlighting, PWA support, and MDX/React
+components.
+
+## Install
+
+```
+npm i @markdownspace/site-generator
+```
+
+## Usage
+
+```js
+import SiteGenerator, {
+    parseFrontmatter,
+    AvailableBootstrapThemes,
+    AvailableBulmaThemes
+} from '@markdownspace/site-generator'
+
+const html = SiteGenerator.generate(
+    project, // { id, name, slug, pwa_support, documents? }
+    doc,     // { id, name, slug }
+    [],      // template contents to prefix (usually `_templates/*` docs)
+    rawMarkdown, // the document body, optionally starting with YAML frontmatter
+    baseURL  // e.g. 'https://example.com/'
+)
+```
+
+`generate()` returns a complete HTML document string.
+
+The same package runs in the browser (live previews), in Node, and in
+Cloudflare Workers.
+
+### Frontmatter options
+
+Control the generated site from YAML frontmatter at the top of the document:
+
+```yaml
+---
+title: My Page
+description: A page about something
+theme: litera            # bootswatch/bulmaswatch theme name, or a full CSS URL
+cssFramework: bulma      # 'bulma' (default) or 'bootstrap'
+navbar: true
+navbarTheme: dark
+navbarLogo: /logo.png
+navbarAutoLinks: true    # navbar links to every document in the project
+overrideNavLinks:        # or explicit links
+  - text: Home
+    href: /
+mdx: true                # compile MDX/JSX (React via esm.sh)
+autoclasses:             # extra classes for rehype-add-classes
+  h2: title is-4
+favicon: /favicon.ico
+ogImage: /og-image.png
+filesHost: https://files.example.com      # override asset host (default: https://files.markdown.space)
+defaultFaviconBase: https://cdn.example.com  # default favicon set base (default: markdown.space R2)
+codeTheme: atom-dark-one
+headPrepend: '<!-- ... -->'
+headAppend: ''
+bodyPrepend: ''
+bodyAppend: ''
+---
+```
+
+## Development
+
+```
+npm i
+npm run build    # esbuild bundle to dist/ + type declarations to dist-types/
+npm test         # vitest
+npm run build:w  # watch mode
+```
+
+The bundle inlines the mustache layout templates (`src/templates/*.mustache`)
+and polyfills node built-ins so the output runs in browsers and workers.
+
+## Releasing
+
+Releases are published to npm automatically when a GitHub release is created
+(`.github/workflows/publish-npm.yml`).