https://github.com/cbush/snooty-mockup

Mock up snooty sites from JSON
https://github.com/cbush/snooty-mockup

Last synced: 8 days ago
JSON representation

Mock up snooty sites from JSON

• Host: GitHub
• URL: https://github.com/cbush/snooty-mockup
• Owner: cbush
• Created: 2021-10-22T16:47:14.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-10-22T18:21:18.000Z (over 3 years ago)
• Last Synced: 2024-10-02T12:41:17.361Z (4 months ago)
• Language: TypeScript
• Size: 169 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Snooty Mockup

Mock up sites quickly from a JSON manifest file.

## Install Dependencies & Build

```shell

npm install

npm run build

```

## Manifest Format

A manifest file is a JSON file that shows pages and sections to build for the

site. The root object is a `Page`.

```json

{

  "title": "The Title of the Page",

  "children": [

    // Child pages if the page is a 'section'

  ],

}

```

A page can be represented by either a `Page` object (as above) or with just a

string. A string is interpreted as the title of a leaf page.

## Run the App

The following command takes the manifest.json file and creates the rST/toctrees

at path/to/site/source.

```shell

node path/to/snooty-mockup/build/main.js \

  generate path/to/manifest.json \

  -o path/to/site/source

```