lanasina / myst_nca Goto Github PK

{"kind":"Article","sha256":"a946e38d1a91a395f7e02a48cc5066ddbce8c598d5c2438ffbbbbdd0768539f4","slug":"readme","dependencies":[],"frontmatter":{"title":"MyST Quickstart","authors":[],"github":"https://github.com/executablebooks/mystjs-quickstart","keywords":[],"thumbnail":"/mystmosa/build/c46244155f82f0a2188b900fb12670c3.svg","exports":[{"format":"md","filename":"README.md","url":"/mystmosa/build/README-1122bc7773576a2c8d0ea85d70d2390b.md"}]},"mdast":{"type":"root","children":[{"type":"block","children":[{"type":"paragraph","position":{"start":{"line":2,"column":0},"end":{"line":3,"column":0}},"children":[{"type":"link","url":"https://myst.tools","children":[{"type":"image","url":"/mystmosa/build/c46244155f82f0a2188b900fb12670c3.svg","alt":"Made with MyST","urlSource":"https://img.shields.io/badge/made%20with-myst-orange","key":"hruWoy3MuE"}],"urlSource":"https://myst.tools","key":"O2X4wyb5Zu"}],"key":"GsUPVWsidv"},{"type":"paragraph","position":{"start":{"line":4,"column":0},"end":{"line":5,"column":0}},"children":[{"type":"text","value":"This repository contains the files used in the ","key":"R4b810BloW"},{"type":"link","url":"https://myst.tools/docs/mystjs/quickstart","children":[{"type":"text","value":"quickstart guide","key":"rlEEkDc5Jn"}],"urlSource":"https://myst.tools/docs/mystjs/quickstart","key":"t0QqkfvNKW"},{"type":"text","value":", and can be used to follow that guide, before trying MyST with your own content.","key":"d23FXuxJkr"}],"key":"E0gjiiGOUE"},{"type":"admonition","position":{"start":{"line":6,"column":0},"end":{"line":7,"column":0}},"children":[{"type":"admonitionTitle","children":[{"type":"text","value":"Note","key":"di1W30HfOs"}],"key":"rpebP8GMry"},{"type":"paragraph","position":{"start":{"line":6,"column":0},"end":{"line":7,"column":0}},"children":[{"type":"text","value":" This is ","key":"aFTgt74PSD"},{"type":"strong","children":[{"type":"text","value":"not","key":"YDbrHjRWYW"}],"key":"tAylXuEMfV"},{"type":"text","value":" a good example of an actual myst project! The repositories purpose is to be a simple markdown + notebook repository that can be transformed throughout a tutorial.","key":"kjfvMn5YPq"}],"key":"oqu3lGBSRC"}],"kind":"note","class":"simple","key":"NAHhhqMcjK"},{"type":"paragraph","position":{"start":{"line":8,"column":0},"end":{"line":9,"column":0}},"children":[{"type":"text","value":"The goals of the ","key":"I1Yo1nFKSt"},{"type":"link","url":"https://myst.tools/docs/mystjs/quickstart","children":[{"type":"text","value":"quickstart guide","key":"X0TDFGqby7"}],"urlSource":"https://myst.tools/docs/mystjs/quickstart","key":"WHYEx1RPTa"},{"type":"text","value":" are:","key":"qQETrgdrpi"}],"key":"bTBCjYqpDJ"},{"type":"list","ordered":true,"start":1,"spread":false,"position":{"start":{"line":10,"column":0},"end":{"line":16,"column":0}},"children":[{"type":"listItem","spread":true,"position":{"start":{"line":10,"column":0},"end":{"line":11,"column":0}},"children":[{"type":"text","value":"Create a ","key":"fhi5ViH7Kf"},{"type":"inlineCode","value":"myst","key":"YF39iZ4EyY"},{"type":"text","value":" site, using the standard template","key":"wfkDUafaHb"}],"key":"vIJuQgzUnE"},{"type":"listItem","spread":true,"position":{"start":{"line":11,"column":0},"end":{"line":12,"column":0}},"children":[{"type":"text","value":"Improve the frontmatter, to add authors, affiliations and other metadata","key":"TIzWNw2w2g"}],"key":"GlmF29mHnD"},{"type":"listItem","spread":true,"position":{"start":{"line":12,"column":0},"end":{"line":13,"column":0}},"children":[{"type":"text","value":"Export the paper as a PDF, Word document, and LaTeX files","key":"QoJTkkFvdP"}],"key":"nFxEKTES23"},{"type":"listItem","spread":true,"position":{"start":{"line":13,"column":0},"end":{"line":14,"column":0}},"children":[{"type":"text","value":"Integrate a Jupyter Notebook output into our paper, to improve reproducibility","key":"LoYCoS8WL1"}],"key":"K0J5A0HEq4"},{"type":"listItem","spread":true,"position":{"start":{"line":14,"column":0},"end":{"line":16,"column":0}},"children":[{"type":"text","value":"Publish a website of with our work 🚀","key":"SVWA0N3ucA"}],"key":"aMPaoJs0Xp"}],"key":"Om3iDMnkTV"},{"type":"heading","depth":2,"position":{"start":{"line":16,"column":0},"end":{"line":17,"column":0}},"children":[{"type":"text","value":"Improving Frontmatter and MyST Site","key":"nY6wRHQMmz"}],"identifier":"improving-frontmatter-and-myst-site","label":"Improving Frontmatter and MyST Site","html_id":"improving-frontmatter-and-myst-site","implicit":true,"key":"qOEkFb7a3A"},{"type":"image","url":"/mystmosa/build/frontmatter-after-f9f9c47aa7cbc9a63c448ecbfcbc9d83.png","urlSource":"./images/frontmatter-after.png","urlOptimized":"/mystmosa/build/frontmatter-after-f9f9c47aa7cbc9a63c448ecbfcbc9d83.webp","key":"HUM1yOBEB3"},{"type":"heading","depth":2,"position":{"start":{"line":20,"column":0},"end":{"line":21,"column":0}},"children":[{"type":"text","value":"Export as a PDF","key":"idjKAo6YEE"}],"identifier":"export-as-a-pdf","label":"Export as a PDF","html_id":"export-as-a-pdf","implicit":true,"key":"h7GV0JnV9e"},{"type":"image","url":"/mystmosa/build/export-pdf-396de6c8e1d61bf0abc7dd240a071809.png","urlSource":"./images/export-pdf.png","urlOptimized":"/mystmosa/build/export-pdf-396de6c8e1d61bf0abc7dd240a071809.webp","key":"Y6b6NdnUAK"}],"key":"OaCtgaxndj"}],"key":"oaQBn3i2QP"},"references":{"cite":{"order":[],"data":{}}},"footer":{},"domain":"http://localhost:3000"}