Best Practice Create Documentation for Your Application with VueJS

building simple documentation with vuepress, vuejs

Transcript

1. Best Practice Create Documentation for your Application using VueJS #iTalk2018
2. Sigit Prabowo Web Developer, Tirto.ID Entusiast in Front End Web development, Chatbot
3. Documentation Place you get started in; for your skripsi* maybe; when you decided to resign *ups
4. * Mulai pakai terminal *
5. curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash - sudo apt-get install -y nodejs https://yarnpkg.com/lang/en/docs/install/#debian-stable Install NodeJS (v.8+), yarn /documentaksi —/package.json —/docs ——/README.md ——/cara-install.md ——/requirement.md ——/.vuepress ———/config.js Structur foldernya Install Vuepress as Global yarn global add vuepress
6. $ mkdir dokumentaksi
7. package.json { "scripts": { "docs:dev": "vuepress dev docs", "docs:build": "vuepress build docs" } }
8. $ mkdir docs $ vi README.md
9. README.md --- home: true actionText: Mulai → actionLink: /cara-install ---
10. $ cd .. $ yarn docs:dev
12. cara-install.md --- title: Cara Install meta: - name: keywords - content: install dokumentaksi, dokumentaksi instalasi --- # Cara Install Ini cara installnya seperti ini lho jangan sampai salah ya
13. requirement.md --- title: Requirement meta: - name: keywords - content: kebutuhan untuk sistem dokumentaksi, requirement --- # Requirement jadi kebutuhannya adalah begini begitu
14. $ mkdir .vuepress $ cd .vuepress $ vi config.js
15. config.js module.exports = { title: "Dokumentaksi", description: "Deskripsi Dokumentaksi", themeConfig: { sidebar: [ ['', 'Beranda'], // untuk default ke home page 'cara-install', ['requirement', 'Requirement'] ] } }
16. $ cd dokumentaksi $ yarn docs:dev
17. Deployment
18. $ yarn docs:build $ cd docs/.vuepress/dist $ yarn global add surge $ surge
19. http://demo-dokumentaksi.surge.sh http://bit.ly/demodokumentaksi https://github.com/sprabowo/dokumentaksi
20. –Sigit Prabowo Thanks