Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/toggledtech/toggled-cli
Command line interface for Toggled.tech. Design, develop, and deploy packages for TPR.
https://github.com/toggledtech/toggled-cli
html markdown markdown-to-html md mdx npm npm-package toggled
Last synced: about 1 month ago
JSON representation
Command line interface for Toggled.tech. Design, develop, and deploy packages for TPR.
- Host: GitHub
- URL: https://github.com/toggledtech/toggled-cli
- Owner: toggledtech
- License: other
- Created: 2024-01-07T01:58:07.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-01-07T02:01:16.000Z (12 months ago)
- Last Synced: 2024-11-18T12:52:21.528Z (about 1 month ago)
- Topics: html, markdown, markdown-to-html, md, mdx, npm, npm-package, toggled
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/toggled-cli
- Size: 2.93 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Design Something Great... In seconds
With Toggled creating a beautiful website has never been easier.
Toggled allows you to make beautiful websites with Markdown or HTML or both. Toggled also integrates directly into your favorite work environments such as GitHub and Replit.
Visit our [starter repository](https://github.com/toggledtech/Toggled-Starter) to get started today.
[Try Toggled Today](https://toggled.tech)
# Using The Toggled CLI
Use this to design, develop, and deploy packages, addons, and more for Toggled.tech. This is intended for use of advanced developers only.
## Getting Started
Install it with:
```bash
npm i toggled-cli
```
### toggled.json
The first step to designing anything with the Toggled CLI is creating a toggled.json file.
You can do this by running the following command in the terminal.
```bash
toggled init package
```
This will create a new toggled.json file with the type set to package.
### Package Code
Design the custom elements in the file set as `main` in toggled.json.
```js
export const BLOCKNAME = (e) => {
//e is the parent element of the block access dataset via e.dataset
const blockCode = `
Hello World
`;
return blockCode;
};
```
You must return the block in an HTML format readable by the browser.
### Deployment
There are two ways to deploy your custom blocks. If you want full control over hosting then you can host it on your own servers statically. Then import it like this:
```js
import { BLOCKNAME } from 'https://your-server.com/your-file.js'
```
Your server must be https and configured for CORS. See https://toggled.tech/site/toggledtech-docs/Imports.
---
The other option it to deploy it directly from the CLI to our servers. This won't give you as much control but you will not have to worry about hosting.
Deploy it by running this command in terminal.
```bash
toggled package
```
Then import it like this:
```js
import { BLOCKNAME } from 'PACKAGE_NAME'
```
Your package name is specified as `name` in toggled.json. (Note even if the name has uppercases, the server will always make it lowercase)