VuePress: Documentation Made Easy

VUEPRESS DOCUMENTATION MADE EASY By Ben Hong www.bencodezen.com DEVFEST DC 2018

BEFORE WE GET STARTED... YOU CAN FIND THE SLIDES HERE: https://www.twitter.com/bencodezen AND FOR SOCIAL MEDIA POSTS: #vuepress

BEN HONG Senior UI Developer @ POLITICO @bencodezen

VUEDC https://www.vuedc.io BEN HONG Senior UI Developer @ POLITICO @bencodezen

VUEDC https://www.vuedc.io BEN HONG Senior UI Developer @ POLITICO @bencodezen VUEMEETUPS https://www.vuemeetups.org

“ Documentation can be difficult, but it is the key to any project's long term success.

README.MD

CONFLUENCE

BUILD YOUR OWN

BUILD YOUR OWN What tech stack do you use?

BUILD YOUR OWN What tech stack do you use? What does the design look like?

BUILD YOUR OWN What tech stack do you use? What does the design look like? What features should it have?

BUILD YOUR OWN What tech stack do you use? What does the design look like? What features should it have? Is it easy to maintain?

BUILD YOUR OWN What tech stack do you use? What does the design look like? What features should it have? Is it easy to maintain? Who is going to pay for this?

LIVING & GOOD DOCUMENTATION IS HARD

ENTER VUEPRESS

“ VuePress is a static site generator with a Vue-powered theming system that comes with a default theme optimized for technical documentation.

WHAT MAKES VUEPRESS GREAT?

WHAT MAKES VUEPRESS GREAT? Provides an incredible default theme that allows you to focus on what's important: writing documentation

DEFAULT THEME FEATURES

DEFAULT THEME FEATURES 1. Homepage

DEFAULT THEME FEATURES 1. Homepage 2. Navbar

DEFAULT THEME FEATURES 1. Homepage 2. Navbar 3. Sidebar

DEFAULT THEME FEATURES 1. Homepage 2. Navbar 3. Sidebar 4. Built-in Search

DEFAULT THEME FEATURES 1. Homepage 2. Navbar 3. Sidebar 4. Built-in Search 5. Git Repo

DEFAULT THEME FEATURES 1. Homepage 2. Navbar 3. Sidebar 4. Built-in Search 5. Git Repo 6. Last Updated & Edit links

WHAT MAKES VUEPRESS GREAT? Provides an incredible default theme that allows you to focus on what's important: writing documentation

WHAT MAKES VUEPRESS GREAT? Provides an incredible default theme that allows you to focus on what's important: writing documentation It leverages technology and languages that developers are already comfortable with

THINGS YOU NEED TO KNOW

THINGS YOU NEED TO KNOW 1) npm install / npm run dev

THINGS YOU NEED TO KNOW 1) npm install / npm run dev 2) Markdown syntax

THINGS YOU NEED TO KNOW 1) npm install / npm run dev 2) Markdown syntax 3) Git

THINGS YOU NEED TO KNOW 1) npm install / npm run dev 2) Markdown syntax 3) Git 4) . . . That's it

WHAT MAKES VUEPRESS GREAT? Provides an incredible default theme that allows you to focus on what's important: writing documentation It leverages technology and languages that developers are already comfortable with

WHAT MAKES VUEPRESS GREAT? Provides an incredible default theme that allows you to focus on what's important: writing documentation It leverages technology and languages that developers are already comfortable with Contains built-in markdown extensions that are optimized for technical documentation

COOL MARKDOWN EXTENSIONS

COOL MARKDOWN EXTENSIONS 1. Emojis

COOL MARKDOWN EXTENSIONS 1. Emojis 2. Front Matter

COOL MARKDOWN EXTENSIONS 1. Emojis 2. Front Matter 3. GitHub-Style Tables

COOL MARKDOWN EXTENSIONS 1. Emojis 2. Front Matter 3. GitHub-Style Tables 4. Code Syntax Highlighting

COOL MARKDOWN EXTENSIONS 1. Emojis 2. Front Matter 3. GitHub-Style Tables 4. Code Syntax Highlighting 5. Line Highlighting in Code Blocks

COOL MARKDOWN EXTENSIONS 1. Emojis 2. Front Matter 3. GitHub-Style Tables 4. Code Syntax Highlighting 5. Line Highlighting in Code Blocks 6. Custom Containers

WHAT MAKES VUEPRESS GREAT? Provides an incredible default theme that allows you to focus on what's important: writing documentation It leverages technology and languages that developers are already comfortable with Contains built-in markdown extensions that are optimized for technical documentation

WHAT MAKES VUEPRESS GREAT? Provides an incredible default theme that allows you to focus on what's important: writing documentation It leverages technology and languages that developers are already comfortable with Contains built-in markdown extensions that are optimized for technical documentation Every page generated by VuePress has its own prerendered static HTML, providing great loading performance and is SEO-friendly

“ VuePress is a static site generator with a Vue-powered theming system that comes with a default theme optimized for technical documentation.

VUE.JS TLDR;

“ Vue is a progressive framework for building user interfaces. Unlike other monolithic frameworks, Vue is designed from the ground up to be incrementally adoptable.

https://stateofjs.com/2017/front-end/results/

THREE VUE.JS FEATURES

DECLARATIVE RENDERING <div id="app"> <h1>Hello {{ conference }}</h1> </div> <script> var app = new Vue({ el: '#app', data() { return { conference: 'DevFestDC!' } } }) </script>

DECLARATIVE RENDERING <div id="app"> <h1>Hello {{ conference }}</h1> </div> <script> var app = new Vue({ el: '#app', data() { return { conference: 'DevFestDC!' } } }) </script> Hello DevFestDC!

DIRECTIVES <div id="app"> <h1>Front-End Trifecta</h1> <ul> <li v-for="language in languages"> {{ language }} </li> </ul> </div> <script> var app = new Vue({ el: '#app', data() { return { languages: [ 'HTML', 'CSS', 'JavaScript' ] } } }) </script>

DIRECTIVES <div id="app"> <h1>Front-End Trifecta</h1> <ul> <li v-for="language in languages"> {{ language }} </li> </ul> </div> <script> var app = new Vue({ el: '#app', data() { return { languages: [ 'HTML', 'CSS', 'JavaScript' ] } } }) </script> Front-End Trifecta HTML CSS JavaScript

SINGLE FILE COMPONENTS <template> <div> <h2 class="title">Single File Components</h2> <p>They are {{ adjective }}!</p> </div> </template> <script> export default { name: 'SimpleComponent', data() { return { adjective: 'game changing' } } } </script> <style> .title { font-color: #BADA55; } </style>

SINGLE FILE COMPONENTS <template> <div> <h1>Single File Components In Action!</h1> <SimpleComponent /> <p>And we have some text here</p> <SimpleComponent /> </div> </template> <script> import SimpleComponent from './components/SimpleComponent' export default { name: 'App', components: { SimpleComponent } } </script>

“ Vue is the most compassionate framework in the market right now because it allows you to choose what's best for you.

BACK TO VUEPRESS

“ VuePress is a static site generator with a Vue-powered theming system that comes with a default theme optimized for technical documentation.

USE VUE IN MARKDOWN

USE VUE IN MARKDOWN 1. Interpolation

USE VUE IN MARKDOWN 1. Interpolation 2. Access Site and Page Data

USE VUE IN MARKDOWN 1. Interpolation 2. Access Site and Page Data 3. Directives

USE VUE IN MARKDOWN 1. Interpolation 2. Access Site and Page Data 3. Directives 4. Single File Components

HOW DO I GET STARTED? STARTED? https://vuepress.vuejs.org/ https://github.com/bencodezen /vuepress-starter-kit

Q&A

THANKS! @bencodezen

VuePress: Documentation Made Easy

Slide 1

Slide 2

Slide 3

Slide 4

Slide 5

Slide 6

Slide 7

Slide 8

Slide 9

Slide 10

Slide 11

Slide 12

Slide 13

Slide 14

Slide 15

Slide 16

Slide 17

Slide 18

Slide 19

Slide 20

Slide 21

Slide 22

Slide 23

Slide 24

Slide 25

Slide 26

Slide 27

Slide 28

Slide 29

Slide 30

Slide 31

Slide 32

Slide 33

Slide 34

Slide 35

Slide 36

Slide 37

Slide 38

Slide 39

Slide 40

Slide 41

Slide 42

Slide 43

Slide 44

Slide 45

Slide 46

Slide 47

Slide 48

Slide 49

Slide 50

Slide 51

Slide 52

Slide 53

Slide 54

Slide 55

Slide 56

Slide 57

Slide 58

Slide 59

Slide 60

Slide 61

Slide 62

Slide 63

Slide 64

Slide 65

Slide 66

Slide 67

Slide 68

Slide 69

Slide 70

Slide 71

Slide 72