Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/toggledtech/docs

Toggled.tech Documentation.
https://github.com/toggledtech/docs

builder html-css-javascript markdown mdx website website-builder website-builder-framework website-building website-building-platform

Last synced: 5 days ago
JSON representation

Toggled.tech Documentation.

Awesome Lists containing this project

README

        

---
name: Development
description: Develop Toggled Projects
---

# Getting Started With Toggled

### Fork this Template
Start off by forking our starter template: [https://github.com/toggledtech/Toggled-Starter](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)",
}
```

### Editor Notes

You must create your Toggled site in the `main` branch.