VIDEO TUTORIAL: How To Use "Docsify" To Autocreate Documentation Website For Your Projects
Docsify helps you 'magically' generate a website for the documentation for your projects. Its super straightforward though you require some coding background. Cheers
What Will I Learn?
- You will learn How To Install Docsify-CLI
- You will learn How To Initialize It With The "INIT" Command
- You will learn How To Upload Your Written Content
- You will learn How To Preview The Work You Have Done So Far
- Finally, You will learn How To Magically Create A Documentation Website For Your project
Requirements
To watch this video and learn much you need the following
- An internet-enabled device
- Owning a project you wish to document
- A basic understanding of HTML, CSS, Node.Js coding language
Difficulty
- Advanced
Description
DOCSIFY allows you to easily create a documentation for your project. A documentation is a writeup that details the contents of a project or product. It also details what its used for and how to use it.
The Unique Attributes of Docsify Include;
No statically built html files
Simple and lightweight (~18kB gzipped)
Smart full-text search plugin
Multiple themes
Useful plugin API
Compatible with IE10+
Support SSR (example)
- To visualize the contents that were generated with Docsify visit; https://docsify.js.org/
- Other Examples
Samaritan-http://samaritan.stockdb.org/
Trilogy-http://trilogy.js.org/
JS MythBusters-https://mythbusters.js.org/
- HOW TO USE DOCSIFY
Visit - https://docsify.js.org/#/quickstart
Install with Docsify-CLI-->Initialize with "INIT" command-->Write Your Content eg Index.html-->Preview The Work Done-->Let The webite run for free.
WATCH VIDEO TUTORIAL
VIDEO DETAILS:
- Production: Made with my Tecno Winpro II Tablet
- Narration: In My Voice
- Hosting: Youtube
- Length: 11+mins
- Language: English
- Subtitle: YES
Thanks for watching! Feel free to ask your questions below. Cheers!
Curriculum
This is one of my #OpenSourceInfoSeries. You can watch other works I have done in the past below:
- How To Use "Countly" Data Analytics For Website/App Owners
- How To Use "Steem Projects" For More Visibility
- How To Check Your Steemit Rewards
- How To PowerUp/Power Down On Steemit
- How To Use "Steem Accounts" To Create Instant Steemit Accounts
Posted on Utopian.io - Rewarding Open Source Contributors
That tutorial was really educative.
Ohhh i learnt something new, thankss
Thank you for the contribution. It has been approved.
You can contact us on Discord.
[utopian-moderator]
Hey @nairadaddy I am @utopian-io. I have just upvoted you!
Achievements
Community-Driven Witness!
I am the first and only Steem Community-Driven Witness. Participate on Discord. Lets GROW TOGETHER!
Up-vote this comment to grow my power and help Open Source contributions like this one. Want to chat? Join me on Discord https://discord.gg/Pc8HG9x
This is educational, thank you so much for sharing at least I feel one step ahead already.
Sorry for my complaint, but you do not show how to create documentation. You just read documentation and explain it. I think more valuable would be create your own documentation and deploy it somewhere. For me it wasn't very helpful.
useless tut video , do not waste your time on it , totally useless