Upload File

docing in-and-out: markdown introduction

24
DOC-ING IN AND OUT allansun.130830@KKBOX

Upload: allan-sun

Post on 28-Nov-2014

622 views

Category:

Technology


0 download

Report

DESCRIPTION

 

TRANSCRIPT

Page 1: Docing in-and-out: Markdown introduction

DOC-ING IN AND OUTallansun.130830@KKBOX

Page 2: Docing in-and-out: Markdown introduction

We sometimes write some comments…

Page 3: Docing in-and-out: Markdown introduction

Not easy to read…

Page 4: Docing in-and-out: Markdown introduction

Introducing: Markdown

Page 5: Docing in-and-out: Markdown introduction

What is Markdown?• A lightweight markup language

• “To write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML(or HTML)”

• In brief:• Write in plaintext• Read in rich format or plaintext

Page 6: Docing in-and-out: Markdown introduction

Trend of Markdown

Page 7: Docing in-and-out: Markdown introduction

Useful to coders

Page 8: Docing in-and-out: Markdown introduction

Pretty Results

Page 9: Docing in-and-out: Markdown introduction

Maybe profitable..?

Page 10: Docing in-and-out: Markdown introduction

How to write?• Headings• Paragraphs• Lists• Code• Links & Images• Miscs

Page 11: Docing in-and-out: Markdown introduction

Headings

Page 12: Docing in-and-out: Markdown introduction

Paragraphs

Page 13: Docing in-and-out: Markdown introduction

Lists

Page 14: Docing in-and-out: Markdown introduction

Code

Page 15: Docing in-and-out: Markdown introduction

Links & Images

Page 16: Docing in-and-out: Markdown introduction

Miscs

Page 17: Docing in-and-out: Markdown introduction

So we’re now using Markdown…

• In our opensource project: KKBOX Android Toolkit• https://github.com/

KKBOX/android_kktoolkit

• README.md• .md is a markdown

extension (Optional)

• Wiki page

Page 18: Docing in-and-out: Markdown introduction

What about in-code comments?• We currently uses Doxygen-style comments

Page 19: Docing in-and-out: Markdown introduction

Comment styles

Page 20: Docing in-and-out: Markdown introduction

Use Doxygen to autogen docs

Page 21: Docing in-and-out: Markdown introduction

Step-by-step• Generate a doxygen configure file• $doxygen doxygen• See the pretty HTML

• We currently made this process cronly due to laziness• Self generate, self update

Page 22: Docing in-and-out: Markdown introduction

Conclusion• Writing document by using Markdown language

• Examples, explanation, blog posts, readme…• Easy to write, easy to read

• Write in-code comments by using Doxygen notations• Not much different between regular comments• Eclipse can help you a bit• Auto-generated documents

• 順手捐發票，救救老殘窮順手寫文件，救救全世界• Please give a helping hand on our open-source project :P

Page 23: Docing in-and-out: Markdown introduction

Refenece• Markdown Project

http://daringfireball.net/projects/markdown/

• 中文版說明http://markdown.tw/

• Github Flavored Markdownhttps://help.github.com/articles/github-flavored-markdown

• Doxygenhttp://www.doxygen.org/

Page 24: Docing in-and-out: Markdown introduction

Q&AThanks!


Easy Markdown User Guide

Introduction to Markdown - University of Texas at Arlingtonstudents.uta.edu/rx/rxr5243/tutorials/markdown_shell_scripting/... · Introduction to Markdown Rohit Rawat ... Inline code

Markdown · What is Markdown? Markdown is a writing tool that allow you to write plain text while tagging your formatting. It’s much more readable than HTML “The idea is that

Markup and markdown

R Markdown - Journalism Courses Knight Center · 2020. 8. 5. · R Markdown Andrew Ba Tran Contents WhatisMarkdown? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Markdown Strategy: Improving margin by establishing better markdown

An introduction to knitr and R Markdown

Markdown: Installing my favorite tools

2019 MARKDOWN SCHEDULE

Oracle® Retail Markdown Optimization · The Oracle Retail Markdown Optimization User’s Guide is intended for Markdown Optimization users. It covers user tasks and application functionality

Introduction to R Markdown - Projet MiRoRmiror-ejd.eu/wp-content/uploads/sites/34/2016/10/Introduction-to-Markdown-1.pdfMarkdown is also a syntax for styling text on the GitHub platform

A Markdown Interpreter for TeX - University of Washingtonctan.math.washington.edu/.../generic/markdown/markdown.pdf · 2020. 3. 21. · 10if not modules then modules = { } end 11modules['markdown']

Introduction to markdown and git - Statistical Sciencercs46/lectures_2015/01-markdown-git/01-intro … · Git Git is a version control system. I It’s a tool that tracks changes

What is mmd - Multi Markdown ?

Introduction to R Markdown - Yan Holtz · “ An R Markdown (.Rmd) file is a record of your research. It contains the code that a scientist needs to reproduce your work along with

Simple Reproducible Analysis with knitr, R Markdown, and RStudio …fobos.inf.um.es/R/taller5j/10-presentacion/main.pdf · 2013. 12. 13. · Markdown, and RStudio Jeromy Anglim Introduction

DITA and Markdown - oxygenxml.comDITA and Markdown What is Lightweight DITA? LwDITA is a proposed standard for expressing simplified DITA documents in XML, HTML5, and Markdown. The

CommonMark: Markdown Done Right

Eduardo Guamán Introducción a R Markdown · R Markdown es un formato que permite una fácil creación de documentos, presentaciones dinámicas e informes de R. R Markdown admite

R Markdown Cheat Sheet - Hello FriendR Markdown Cheat Sheet ... Several functions format R data into tables data

INTRODUCTION TO R MARKDOWN AND LITERATE PROGRAMMING

Learning R Markdown and Notebooks in RStudio - ariel.rbind.io · Learning R Markdown and Notebooks in RStudio May 16, 2018 Contents Introduction 3 InstallLaTeXdistributionviatinytex

4R MARKDOWN OPTIMISATION · your primary concern, the best markdown will balance retail price reduction against sales increase. To maximise inventory consumption, your markdown should

The Markdown Guidemarkdown.p2hp.com/assets/book/markdown-guide.pdf · If you’re a WordPress user, you’ll be happy to know there’s Markdown ... To emphasize text with bold and

Markdown By Example · Simpletext 2 Simpletext Since Markdown is supposed to make reading and writingfileseasywithoutstrippingtheauthorofthe abilitytocreatewellformattedoutput,aMarkdown

Markdown Suite€¦ · Fall in Love: A Markdown Solution Made for You Maximize Return on Inventory, Margins and Sell-Through Revionics Markdown Suite effectively manages the complexities

Adapting a Markdown Compiler’s Parser for Syntax Highlightinghasseg.org/peg-markdown-highlight/peg-markdown-highlight.pdf · discuss Markdown’s context sensitivity (and the implications

Publishing alchemy with markdown and pandoc

markdown-memo example document - Ryan Reecerreece.github.io/sw/markdown-memo/example.pdf · DRAFT:November1,2017. Pleasedonotcitewithoutpermission.EXAMPLE-DOC-000 markdown-memo example

A Markdown Interpreter for TeX - University of Utahctan.math.utah.edu/.../macros/generic/markdown/markdown.pdf · 2020. 9. 14. · 10if not modules then modules = { } end 11modules['markdown']

Markdown Slides [EN]

Oracle Retail Markdown Optimization - Data sheet | Oracle · Oracle Retail Markdown Optimization With Oracle Retail Markdown Optimization, it is easy to improve lifecycle pricing

Robust Timing of Markdowns - Optimization Onlinethe markdown, and argue that an early near-optimal markdown typically results in higher revenues than a late, but optimal markdown

A Markdown Interpreter for TeX - TeXdoc Onlinetexdoc.net/texmf-dist/doc/generic/markdown/markdown.pdf10if not modules then modules = { } end 11modules['markdown'] = metadata 1.1 Feedback

IS YOUR MARKDOWN OPTIMIZATION STRATEGY · 2020. 4. 22. · markdown budgets likely to be significantly higher this year, markdown decisions will be a major focal point for 2020. Regardless