Principium apertum optimum habere potes, sed documenta bona si non habet, casus numquam auferet. In officio te prohibebit bona documenta iisdem quaestionibus respondere. Documenta etiam efficit ut homines consilium comprehendere possint si key conductos relinquat societas vel munerum mutatio. Viventes normas adiuvabunt ut notitia integritatis.
Si longum opus scribere debes, Markdown magnum alternatio est HTML. Interdum Markdown syntaxin satis non est. In hoc casu HTML intus uti possumus. Velut, mos elementorum. Si igitur systematis instrumenti cum indigenis interretialibus construis, facile in textu documentorum comprehendi possunt. Si React (vel quovis alio compage JSX sicut Preact vel Vue), idem facere potes cum MDX.
Hic articulus amplus est speculatio instrumentorum ad documenta scribenda et ad lineamenta creanda. Instrumenta non omnia instrumenta hic MDX enumerantur, sed magis magisque in instrumentis documentorum comprehenduntur.
Quid MDX?
lima .mdx Eadem syntaxis cum Markdown habet, sed te permittit ut interactive partes JSX importare et eas in continuum tuum inseruerit. Support for Vue components is in alpha. Incipere opus cum MDX, iustus install "crea React App". There are plugins for Next.js et Gatsby. Postera versio Docusauri (versio 2) indigenam quoque sustentationem habebit.
Documenta scribo cum Docusauro
Docusaurus in Facebook scripsit. Utuntur ea in omni fonte aperto praeter React. Extra comitatum quod dicitur Redux, Prettier, Gulp et Babel.
Incepta quae utuntur Docusauro.
Docusaurus potest scribere nihil documenta, non solum frontend describere. React sub cucullo habet, sed non familiariter uti. Documenta tua Markdown capit, ternum magicae et bene structae, formatae ac lectivae documenta cum pulchri consilio parata est.
In Redux website vexillum Docussaurus templates videre potes
Websites cum Docusauro constructae etiam a Markdown substructio blog comprehendere possunt. Prism.js statim coniungitur ad syntaxin illustrandam. Quamvis Docusaurus relativum nuper apparuit, optimum instrumentum 2018 in StackShare agnitum est.
Aliae Optiones Content Creatio
Docusaurus specialiter destinatur ad documenta creanda. Utique decies centena millia et unum viae sunt ut unum facias locum - solutionem tuam explicare potes in quavis lingua, CMS, vel situ generantis static utere.
Exempli causa, documenta pro React, IBM systema designandi, Apollo et Spiritus CMS Gatsby utuntur - situs static generator qui saepe pro diario usus est. Si laboras cum Vue, bene est tibi optio VuePress. Altera optio est ut genitor in Pythone β MkDocs. Fons apertus est et uno YAML lima utens figuratus. GitBook bene etiam est, sed tantum pro publicis et non-commercialibus iugis liberum est. Potes etiam simpliciter fasciculos mardown onerare utendo Git et cum illis in Github laboret.
Documenting components: Docz, Storybook et Styleguidist
Praeceptiones, ratio delineatio, bibliothecarum componentium - quidquid vocas, nuper admodum populare factum est. Adventus compagum componentium sicut React et instrumenta quae hic memorantur ea a vanitate incepta in utilia instrumenta mutaverunt.
Storybook, Docz et Styleguidistae omnes idem faciunt: interactive elementa et documentum eorum API ostendunt. Proiectum potest habere justos vel etiam centum componentium - omnes cum diversis statibus et generibus. Si partes reddi vis, opus est scire se esse. Ad hoc simpliciter catalogus componentium. DIRECTORIA PRINCIPIA facilis ad inven- tionem omnium partium tuarum praebent. Hoc iuvat constantiam visualem conservare et opus repetitivum vitare.
Haec instrumenta opportunam viam ad diversos status spectandos praebent. Difficile est ut unumquemque statum componentis in contextu verae applicationis repraesentet. Loco strepitando in applicatione actuali, elementum separatum enucleare valet. Civitates durae perventurae (ut civitates oneratae) simulari possunt.
Cum demonstratione visuali variarum civitatum et proprietatum indice, saepe necesse est ut generalem descriptionem argumenti - designationis rationum, casuum utentium, vel descriptiones utentis probati eventus scriberet. Markdown est facillime ad discendum - specimen, normas communes esse subsidio pro designandis et tincidunt. Docz, Styleguidist, et Storybook viam praebent ut facile Markdown cum componentibus misceat.
Docz
In statu Docz solum laborat cum React, sed opus active comparatum est ad auxilium Preact, Vue et interretialem. Docz recentissimus trium instrumentorum est, sed colligere per 14 stellas in Github curavit. Docz inducit duas partes <Playground> ΠΈ < Props >. Invecta et in files .mdx.
import { Playground, Props } from "docz";
import Button from "../src/Button";
## You can _write_ **markdown**
### You can import and use components
<Button>click</Button>Involvere potes tuum cum tium React <Playground>analogum constructum in CodePen vel CodeSandbox - hoc est, componentes tuos et videre potes eam creare.
<Playground>
<Button>click</Button>
</Playground><Props> Omnes proprietates in promptu habebunt pro dato React componente, valores defectus, et an res requiratur.
<Props of={Button} />Personaliter hoc MDX innixum accessum invenio ut facillimum ad intelligendum et ad laborem facillimum.
Si ventilabrum Gatsby situs static generator, Docz magnam integrationem praebet.
Style dux
Sicut Docz, exempla scripsit Markdown de syntaxi usus. Styleguidist utitur Markdown codice cuneos (triplex quotes) in iusto files .md files, non MDX.
```js
<Button onClick={() => console.log('clicked')>Push Me</Button>Codicis caudices in Markdown codice fere modo monstrant. Cum usura Styleguidist, quis scandalum codicem cum lingua tag js, jsx aut javascript ut pars React reddet. Sicut Docz, signum editabile est - proprietates mutare potes et statim exitum videre.
Styleguidista sponte creabit mensam proprietatis ex PropTypes, Fluxus vel declarationes Typescript.
Styleguidist currently sustinet React et Vue.
storybook
Storybook positiones ipsas ut "UI progressionem componentium environment." Instead of writing example components intra Markdown vel MDX lima, scribis historia intra files Javascript. historia documentum specifica statum componentis. Exempli gratia, historias potest componentes habere statum oneratum et statum debilitatum.disabled).
storiesOf('Button', module)
.add('disabled', () => (
<Button disabled>lorem ipsum</Button>
))Storybook multo magis implicatus est quam Styleguidist et Docz. Eodem autem tempore haec est optio popularis, consilium plus quam 36 stellarum in Github habet. Fons apertus est cum 000 inceptis contributoribus et baculo pleno. Adhibetur ab Airbnb, Algolia, Atlassian, Lyft et Memasys. Storybook plus compages quam competitores sustinet - React, React Nativum, Vue, Angular, Mithril, Ember, Riot, Svelte et regularis HTML.
In futura emissione notae erunt a Docz et MDX introducendae.
# Button
Some _notes_ about your button written with **markdown syntax**.
<Story name="disabled">
<Button disabled>lorem ipsum</Button>
</Story>Storybook novae lineamenta gradatim in proximos paucos menses evolventur et sicut magnus gradus erit.
results
Beneficia exemplaris bibliotheca extolluntur in decies centena millia articulorum in medio. Cum bene factum, faciliorem reddunt producta cognata et identitatem conservant. Utique, nulla harum instrumentorum magice ratio consilium creabit. Id diligenti consilio et CSS. Sed cum tempus venit ut ratio consiliorum pervia toti societati, Docz, Storybook et Styleguidist, magnae sunt optiones.
Ab interprete. Haec prima experientia in Habre. Si quas incautas invenias, vel suggestiones habeas ad articulum emendandum, scribe ad me in nuntio personali.
Source: www.habr.com