https://github.com/toggledtech/toggled-starter

📰 The boilerplate for your Toggled web app.
https://github.com/toggledtech/toggled-starter

builder carbon html markdown markdownx md md-html mdx mdx-html web webapp website website-builder

Last synced: 2 days ago
JSON representation

📰 The boilerplate for your Toggled web app.

• Host: GitHub
• URL: https://github.com/toggledtech/toggled-starter
• Owner: toggledtech
• License: mit
• Created: 2023-10-15T00:38:24.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-12T02:42:01.000Z (10 months ago)
• Last Synced: 2024-01-27T05:11:45.786Z (10 months ago)
• Topics: builder, carbon, html, markdown, markdownx, md, md-html, mdx, mdx-html, web, webapp, website, website-builder
• Language: MDX
• Homepage: https://toggled.tech/site/toggledtech-Toggled-Starter/
• Size: 83 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Getting Started With Toggled

### Fork this Template

Start off by forking [this template](https://github.com/toggledtech/Toggled-Starter).

![How to fork](https://orionideteam.nimbusweb.me/box/attachment/9239909/lyei9z1e23e316aezdac/x1EYvP0pdTsPfNQ9/screenshot-github.com-2023.09.10-11_07_53.png)

### Toggled.json

All control of your web app can be found in `toggled.json`

Here is what the default `toggled.json` looks like:

```json

{

  "pages": [{

    "name": "Home",

    "doc": "index"

  },

  {

    "name": "About",

    "doc": "about"

  }],

  "logo": "Toggled.png",

  "action": {

    "URL": "//toggled.tech",

    "text": "Try Toggled"

  },

  "title": "Toggled Starter",

  "members": ["Usernames of all Editors and Publishers *"]

}

```

### Adding, Removing, and Customizing Pages

To create a new page, you can need to add a JSON object to the array 'pages'.

```json

{

  "pages": [

    {

      "name": "Display Name (Also shown in URL)",

      "doc": "The file path of the Markdown code in your GitHub repo"

    }

  ]

}

```

Deleting a page can simply be done by removing the object from the `pages` array.

### Customizing your Web App

If you would like to edit the title, favicon, logo, or action button, then this can all be done via the `toggled.json` file.

```json

{

  "logo": "The file path of your logo. 80px x 80px (Cannot use external URL the photo must be in your GitHub Repo)",

  "action": {

    "URL": "The URL of your action button",

    "text": "The display text of your action button"

  },

  "title": "The title in the address bar for your site",

  "favicon": "The file path of your favicon. (Cannot use external URL the photo must be in your GitHub Repo)",

}

```