/// [3/3/3] # FlexDown [1/1/1] ## [Repository](https://github.com/BenjaminPoilve/FlexDownEditor) /// [1/1/1] ---- /// [1/9/0] #### **Content** * Usage * Layout * Basis * Special Cases * Supported Syntax * Basic Markdown * Extensions * Caveats/Next Steps [4/3/9] #### **Introduction** Flexdown is an extension of the [Markdown](https://daringfireball.net/projects/markdown/) syntax to allow some basic layout/responsivity. It automatically generate HTML code from a slightly extended Markdown file. The layout capabilities uses the [Flexbox](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Basic_Concepts_of_Flexbox) CSS norm. The layout is akin to Bootstrap, with a small, medium and big size, which is defined per block by the user, using a `[big/medium/small]` syntax at the beginning of each block. From a usage perspective, I borrowed @oscarmorrison 's idea (and some of it's implementation) to directly transform the Markdown file to html with a .js file in the user's browser. You can see this project [here](https://github.com/oscarmorrison/md-page) This website has been made with it, with my custom CSS /// [1/1/1] [4/9/9] ### **Usage** To use flexdown, you need to : 1. Create a file `index.html` 2. Add some basic Markdown ``` # The title ## The menu  This is the first paragraph ``` 3. Add some layouting informations (can't do it here because it would get interpreted) 4. Add the script tag at the top of the page `