https://github.com/talkjs/tutorials
Repo for draft tutorials
https://github.com/talkjs/tutorials
Last synced: 5 months ago
JSON representation
Repo for draft tutorials
- Host: GitHub
- URL: https://github.com/talkjs/tutorials
- Owner: talkjs
- Created: 2023-06-13T12:50:10.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-05-30T08:50:29.000Z (about 1 year ago)
- Last Synced: 2025-05-30T11:19:06.310Z (about 1 year ago)
- Homepage:
- Size: 17.3 MB
- Stars: 0
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Tutorials
This is the [TalkJS](https://talkjs.com) repo for draft tutorials. We'll review them here and then upload to our [Resources](https://talkjs.com/resources/) site, which uses the [Ghost](https://ghost.org/) platform.
## Notes for writers
- Clone the repo and make a new branch for your tutorial.
- Add your tutorial to a new folder.
- Write tutorials in Markdown – refer to Ghost's [reference guide](https://ghost.org/help/using-markdown/) for details.
- Add images and GIFs to the same folder. They'll need to be wrapped in some custom HTML to display correctly in Ghost, so paste this snippet in where you want the image to appear and fill out the captions and alt text. We'll add the image URL when we upload the tutorial.
```html
TEXT
```
- Create a PR when it's ready to review.
## Notes for reviewers uploading to Ghost
- Paste in the article in a Markdown block.
- Upload the images through Ghost's UI and paste the link in the `` placeholder.