2018-04-29 13:47:56 -04:00
<!DOCTYPE html> < html lang = "en" > < head > < meta charset = "utf-8" / > < meta http-equiv = "X-UA-Compatible" content = "IE=edge" / > < title > Docusaurus · Easy to Maintain Open Source Documentation Websites< / title > < meta name = "viewport" content = "width=device-width" / > < meta name = "generator" content = "Docusaurus" / > < meta property = "og:title" content = "Docusaurus · Easy to Maintain Open Source Documentation Websites" / > < meta property = "og:type" content = "website" / > < meta property = "og:url" content = "https://docusaurus.io/index.html" / > < meta property = "og:description" content = "Easy to Maintain Open Source Documentation Websites" / > < meta property = "og:image" content = "https://docusaurus.io/img/docusaurus.png" / > < meta name = "twitter:card" content = "summary" / > < meta name = "twitter:image" content = "https://docusaurus.io/img/docusaurus.png" / > < link rel = "shortcut icon" href = "/img/docusaurus.ico" / > < link rel = "stylesheet" href = "https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css" / > < link rel = "stylesheet" href = "//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css" / > < link rel = "alternate" type = "application/atom+xml" href = "https://docusaurus.io/blog/atom.xml" title = "Docusaurus Blog ATOM Feed" / > < link rel = "alternate" type = "application/rss+xml" href = "https://docusaurus.io/blog/feed.xml" title = "Docusaurus Blog RSS Feed" / > < script >
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-44373548-31', 'auto');
ga('send', 'pageview');
< / script > < script type = "text/javascript" src = "https://buttons.github.io/buttons.js" > < / script > < link rel = "stylesheet" href = "/css/main.css" / > < / head > < body class = "separateOnPageNav" > < div class = "fixedHeaderContainer" > < div class = "headerWrapper wrapper" > < header > < a href = "/en" > < img class = "logo" src = "/img/docusaurus.svg" alt = "Docusaurus" / > < h2 class = "headerTitle" > Docusaurus< / h2 > < / a > < a href = "/en/versions.html" > < h3 > 1.0.14< / h3 > < / a > < div class = "navigationWrapper navigationSlider" > < nav class = "slidingNav" > < ul class = "nav-site nav-site-internal" > < li class = "" > < a href = "/docs/en/installation.html" target = "_self" > Docs< / a > < / li > < li class = "" > < a href = "/en/help.html" target = "_self" > Help< / a > < / li > < li class = "" > < a href = "/en/users.html" target = "_self" > Users< / a > < / li > < li class = "" > < a href = "/en/about-slash.html" target = "_self" > About /< / a > < / li > < li class = "" > < a href = "/blog" target = "_self" > Blog< / a > < / li > < li class = "" > < a href = "https://github.com/facebook/docusaurus" target = "_self" > GitHub< / a > < / li > < li class = "navSearchWrapper reactNavSearchWrapper" > < input type = "text" id = "search_input_react" placeholder = "Search" title = "Search" / > < / li > < / ul > < / nav > < / div > < / header > < / div > < / div > < div class = "navPusher" > < div > < div class = "homeContainer" > < div class = "homeSplashFade" > < div class = "wrapper homeWrapper" > < div class = "projectLogo" > < img src = "/img/docusaurus_keytar.svg" alt = "Docusaurus with Keytar" / > < / div > < div class = "inner" > < h2 class = "projectTitle" > Docusaurus< small > Easy to Maintain Open Source Documentation Websites< / small > < / h2 > < div class = "section promoSection" > < div class = "promoRow" > < div class = "pluginRowBlock" > < div class = "pluginWrapper buttonWrapper" > < a class = "button" href = "
2017-12-12 13:19:28 -05:00
/docs/en/installation.html
2018-04-07 22:14:31 -04:00
" target="_self">Get Started< / a > < / div > < div class = "pluginWrapper buttonWrapper" > < a class = "button" href = "https://github.com/facebook/Docusaurus" target = "_self" > GitHub< / a > < / div > < / div > < / div > < / div > < / div > < / div > < / div > < / div > < div class = "mainContainer" > < div class = "container paddingBottom paddingTop" > < div class = "wrapper" > < div class = "gridBlock" > < div class = "blockElement alignCenter imageAlignTop threeByGridBlock" > < div class = "blockImage" > < img src = "/img/markdown.png" alt = "Markdown" / > < / div > < div class = "blockContent" > < h2 > < div > < span > < p > Powered by Markdown< / p >
2017-12-12 13:19:28 -05:00
< / span > < / div > < / h2 > < div > < span > < p > Save time and focus on your project's documentation. Simply
2017-12-19 12:24:56 -05:00
write docs and blog posts with < a href = "/docs/en/doc-markdown.html" > Markdown< / a >
2017-12-12 13:19:28 -05:00
and Docusaurus will publish a set of static html files ready
to serve.< / p >
2018-04-07 22:14:31 -04:00
< / span > < / div > < / div > < / div > < div class = "blockElement alignCenter imageAlignTop threeByGridBlock" > < div class = "blockImage" > < img src = "/img/react.svg" alt = "React" / > < / div > < div class = "blockContent" > < h2 > < div > < span > < p > Built Using React< / p >
2017-12-19 12:24:56 -05:00
< / span > < / div > < / h2 > < div > < span > < p > < a href = "/docs/en/api-pages.html" > Extend or customize< / a >
2017-12-12 13:19:28 -05:00
your project's layout by reusing React. Docusaurus can be
extended while reusing the same header and footer.< / p >
2018-04-07 22:14:31 -04:00
< / span > < / div > < / div > < / div > < div class = "blockElement alignCenter imageAlignTop threeByGridBlock" > < div class = "blockImage" > < img src = "/img/translation.svg" alt = "Translation" / > < / div > < div class = "blockContent" > < h2 > < div > < span > < p > Ready for Translations< / p >
2017-12-19 12:24:56 -05:00
< / span > < / div > < / h2 > < div > < span > < p > < a href = "/docs/en/translation.html" > Localization< / a >
2017-12-12 13:19:28 -05:00
comes pre-configured. Use < a href = "https://crowdin.com/" > Crowdin< / a > to translate your docs
into over 70 languages.< / p >
2018-04-07 22:14:31 -04:00
< / span > < / div > < / div > < / div > < / div > < br / > < br / > < div class = "gridBlock" > < div class = "blockElement alignCenter imageAlignTop twoByGridBlock" > < div class = "blockImage" > < img src = "/img/versioning.svg" alt = "Document Versioning" / > < / div > < div class = "blockContent" > < h2 > < div > < span > < p > Document Versioning< / p >
2017-12-12 13:19:28 -05:00
< / span > < / div > < / h2 > < div > < span > < p > Support users on all versions of your project. Document
2017-12-19 12:24:56 -05:00
< a href = "/docs/en/versioning.html" > versioning< / a >
2017-12-12 13:19:28 -05:00
helps you keep documentation in sync with project releases.< / p >
2018-04-07 22:14:31 -04:00
< / span > < / div > < / div > < / div > < div class = "blockElement alignCenter imageAlignTop twoByGridBlock" > < div class = "blockImage" > < img src = "/img/search.svg" alt = "Document Search" / > < / div > < div class = "blockContent" > < h2 > < div > < span > < p > Document Search< / p >
2017-12-19 12:24:56 -05:00
< / span > < / div > < / h2 > < div > < span > < p > Make it easy for your community to < a href = "/docs/en/search.html" > find< / a > what they need in your documentation.
2017-12-12 13:19:28 -05:00
We proudly support < a href = "https://www.algolia.com/" > Algolia documentation search< / a > .< / p >
2018-01-17 22:05:12 -05:00
< / span > < / div > < / div > < / div > < / div > < / div > < / div > < div class = "container lightBackground paddingBottom paddingTop" > < div class = "wrapper" > < div class = "gridBlock" > < div class = "blockElement imageAlignSide imageAlignRight twoByGridBlock" > < div class = "blockContent" > < h2 > < div > < span > < p > Quick Setup< / p >
2017-12-19 12:24:56 -05:00
< / span > < / div > < / h2 > < div > < span > < p > Get < a href = "/docs/en/site-creation.html" > up and running< / a >
2017-12-14 15:21:38 -05:00
quickly without having to worry about site design.< / p >
2018-04-07 22:14:31 -04:00
< / span > < / div > < / div > < div class = "blockImage" > < img src = "/img/docusaurus_speed.svg" alt = "Docusaurus on a Scooter" / > < / div > < / div > < / div > < / div > < / div > < div class = "container paddingBottom paddingTop" > < div class = "wrapper" > < div class = "gridBlock" > < div class = "blockElement imageAlignSide imageAlignLeft twoByGridBlock" > < div class = "blockImage" > < img src = "/img/docusaurus_live.gif" alt = "Docusaurus Demo" / > < / div > < div class = "blockContent" > < h2 > < div > < span > < p > Develop and Deploy< / p >
2017-12-12 13:19:28 -05:00
< / span > < / div > < / h2 > < div > < span > < p > Make design and documentation changes by using the included
2017-12-19 12:24:56 -05:00
< a href = "/docs/en/site-preparation#verifying-installation" > live server< / a > .
< a href = "/docs/en/publishing.html" > Publish< / a >
2017-12-12 13:19:28 -05:00
your site to GitHub pages or other static file hosts
manually, using a script, or with continuous integration
like CircleCI.< / p >
2018-01-17 22:05:12 -05:00
< / span > < / div > < / div > < / div > < / div > < / div > < / div > < div class = "container lightBackground paddingBottom paddingTop" > < div class = "wrapper" > < div class = "gridBlock" > < div class = "blockElement imageAlignSide imageAlignRight twoByGridBlock" > < div class = "blockContent" > < h2 > < div > < span > < p > Website Features< / p >
2017-12-12 13:19:28 -05:00
< / span > < / div > < / h2 > < div > < span > < p > Docusaurus currently provides support to help your website
2017-12-19 12:24:56 -05:00
use < a href = "/docs/en/translation.html" > translations< / a > ,
< a href = "/docs/en/search.html" > search< / a > ,
and < a href = "/docs/en/versioning.html" > versioning< / a > ,
along with some other special < a href = "/docs/en/doc-markdown.html" > documentation markdown features< / a > .
2017-12-12 13:19:28 -05:00
If you have ideas for useful features, feel free to
contribute on < a href = "https://github.com/facebook/docusaurus" > GitHub< / a > !< / p >
2018-04-27 17:30:41 -04:00
< / span > < / div > < / div > < div class = "blockImage" > < img src = "/img/docusaurus_monochrome.svg" alt = "Monochromatic Docusaurus" / > < / div > < / div > < / div > < / div > < / div > < div class = "productShowcaseSection paddingBottom" > < h2 > Who' s Using Docusaurus?< / h2 > < p > Docusaurus is building websites for these projects...< / p > < div class = "logos" > < a href = "https://facebookresearch.github.io/BlueWhale/" > < img src = "/img/BlueWhale.png" alt = "BlueWhale" title = "BlueWhale" / > < / a > < a href = "https://bucklescript.github.io/" > < img src = "/img/bucklescript.svg" alt = "BuckleScript" title = "BuckleScript" / > < / a > < a href = "https://www.docusaurus.io" > < img src = "/img/docusaurus.svg" alt = "Docusaurus" title = "Docusaurus" / > < / a > < a href = "https://fasttext.cc" > < img src = "/img/fasttext.png" alt = "FastText" title = "FastText" / > < / a > < a href = "https://facebook.github.io/jest/" > < img src = "/img/jest.png" alt = "Jest" title = "Jest" / > < / a > < a href = "http://makeitopen.com/" > < img src = "/img/makeitopen.png" alt = "MakeItOpen" title = "MakeItOpen" / > < / a > < a href = "https://www.prettier.io" > < img src = "/img/prettier.png" alt = "Prettier" title = "Prettier" / > < / a > < a href = "https://facebook.github.io/react-native" > < img src = "/img/react-native.svg" alt = "React Native" title = "React Native" / > < / a > < a href = "https://reasonml.github.io/" > < img src = "/img/reason.svg" alt = "Reason" title = "Reason" / > < / a > < a href = "https://reasonml.github.io/reason-react/" > < img src = "/img/reason-react.svg" alt = "ReasonReact" title = "ReasonReact" / > < / a > < a href = "https://facebook.github.io/relay/" > < img src = "/img/relay.svg" alt = "Relay" title = "Relay" / > < / a > < / div > < div class = "more-users" > < a class = "button" href = "/en/users.html" > All Docusaurus Users< / a > < / div > < / div > < div class = "testimonials" > < div class = "container paddingBottom paddingTop" > < div class = "wrapper" > < div class = "gridBlock" > < div class = "blockElement alignCenter imageAlignTop threeByGridBlock" > < div class = "blockImage" > < img src = "/img/christopher-chedeau.jpg" alt = "Christopher "vjeux" Chedeau" / > < / div > < div class = "blockContent" > < h2 > < div > < span > < p > Christopher " vjeux" Chedeau < br / > < font size = "2" > Lead Prettier Developer< / font > < / p >
2018-04-08 00:17:35 -04:00
< / span > < / div > < / h2 > < div > < span > < p > < em > I've helped open source many projects at Facebook and every one needed a website. They all had very similar constraints: the documentation should be written in markdown and be deployed via GitHub pages. None of the existing solutions were great, so I hacked my own and then forked it whenever we needed a new website. I’ ’ < / em > < / p >
2018-04-07 22:14:31 -04:00
< / span > < / div > < / div > < / div > < div class = "blockElement alignCenter imageAlignTop threeByGridBlock" > < div class = "blockImage" > < img src = "/img/hector-ramos.png" alt = "Hector Ramos" / > < / div > < div class = "blockContent" > < h2 > < div > < span > < p > Hector Ramos < br / > < font size = "2" > Lead React Native Advocate< / font > < / p >
2018-04-08 00:17:35 -04:00
< / span > < / div > < / h2 > < div > < span > < p > < em > Open source contributions to the React Native docs have skyrocketed after our move to Docusaurus. The docs are now hosted on a small repo in plain markdown, with none of the clutter that a typical static site generator would require. Thanks Slash!< / em > < / p >
2018-04-07 22:14:31 -04:00
< / span > < / div > < / div > < / div > < div class = "blockElement alignCenter imageAlignTop threeByGridBlock" > < div class = "blockImage" > < img src = "/img/ricky-vetter.jpg" alt = "Ricky Vetter" / > < / div > < div class = "blockContent" > < h2 > < div > < span > < p > Ricky Vetter < br / > < font size = "2" > ReasonReact Developer< / font > < / p >
2018-04-08 00:17:35 -04:00
< / span > < / div > < / h2 > < div > < span > < p > < em > Docusaurus has been a great choice for the ReasonML family of projects. It makes our documentation consistent, i18n-friendly, easy to maintain, and friendly for new contributors.< / em > < / p >
2017-12-13 18:32:27 -05:00
< / span > < / div > < / div > < / div > < / div > < / div > < / div > < / div > < / div > < / div > < footer class = "nav-footer" id = "footer" > < section class = "sitemap" > < a href = "/" class = "nav-home" > < img src = "/img/docusaurus_monochrome.svg" alt = "Docusaurus" width = "66" height = "58" / > < / a > < div > < h5 > Docs< / h5 > < a href = "
2017-12-19 12:24:56 -05:00
/docs/en/installation.html">Getting Started< / a > < a href = "
/docs/en/versioning.html">Versioning< / a > < a href = "
/docs/en/translation.html">Localization< / a > < a href = "
2018-04-29 13:47:56 -04:00
/docs/en/search.html">Adding Search< / a > < / div > < div > < h5 > Community< / h5 > < a href = "/en/users.html" > User Showcase< / a > < a href = "https://twitter.com/docusaurus" > Twitter< / a > < / div > < div > < h5 > More< / h5 > < a href = "https://github.com/facebook/docusaurus" > GitHub< / a > < a class = "github-button" href = "https://github.com/facebook/Docusaurus" data-icon = "octicon-star" data-count-href = "/facebook/Docusaurus/stargazers" data-show-count = "true" data-count-aria-label = "# stargazers on GitHub" aria-label = "Star this project on GitHub" > Star< / a > < / div > < / section > < a href = "https://code.facebook.com/projects/" target = "_blank" rel = "noreferrer noopener" class = "fbOpenSource" > < img src = "/img/oss_logo.png" alt = "Facebook Open Source" width = "170" height = "45" / > < / a > < section class = "copyright" > < span > Copyright © 2018 Facebook Inc.< / span > < / section > < / footer > < / div > < script type = "text/javascript" src = "https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js" > < / script > < script > w i n d o w . f b A s y n c I n i t = f u n c t i o n ( ) { F B . i n i t ( { a p p I d : ' 1 6 1 5 7 8 2 8 1 1 9 7 4 2 2 3 ' , x f b m l : t r u e , v e r s i o n : ' v 2 . 7 ' } ) ; } ; ( f u n c t i o n ( d , s , i d ) { v a r j s , f j s = d . g e t E l e m e n t s B y T a g N a m e ( s ) [ 0 ] ; i f ( d . g e t E l e m e n t B y I d ( i d ) ) { r e t u r n ; } j s = d . c r e a t e E l e m e n t ( s ) ; j s . i d = i d ; j s . s r c = ' / / c o n n e c t . f a c e b o o k . n e t / e n _ U S / s d k . j s ' ; f j s . p a r e n t N o d e . i n s e r t B e f o r e ( j s , f j s ) ; } ( d o c u m e n t , ' s c r i p t ' , ' f a c e b o o k - j s s d k ' ) ) ;
2017-12-13 23:11:41 -05:00
< / script > < script > window . twttr = ( function ( d , s , id ) { var js , fjs = d . getElementsByTagName ( s ) [ 0 ] , t = window . twttr || { } ; if ( d . getElementById ( id ) ) return t ; js = d . createElement ( s ) ; js . id = id ; js . src = 'https://platform.twitter.com/widgets.js' ; fjs . parentNode . insertBefore ( js , fjs ) ; t . _e = [ ] ; t . ready = function ( f ) { t . _e . push ( f ) ; } ; return t ; } ( document , 'script' , 'twitter-wjs' ) ) ; < / script > < script >
2017-12-12 13:19:28 -05:00
var search = docsearch({
2018-03-04 00:46:53 -05:00
2017-12-12 13:19:28 -05:00
apiKey: '3eb9507824b8be89e7a199ecaa1a9d2c',
indexName: 'docusaurus',
inputSelector: '#search_input_react'
});
< / script > < / body > < / html >
