An open API service indexing awesome lists of open source software.

https://github.com/iroco-co/iroco-blog

Source files for the iroco blog
https://github.com/iroco-co/iroco-blog

Last synced: 3 months ago
JSON representation

Source files for the iroco blog

Awesome Lists containing this project

README

        

# iroco.co

Web site source of blog.iroco.co

The site is hosted by netlify.

## Writing

Recommendations

- [One sentence per line](https://asciidoctor.org/docs/asciidoc-recommended-practices/#one-sentence-per-line)
- On code snippet, add language (ex. "```js") to benefit from syntax coloration
- You can draw markdown diagram from code snippets with "```markdown".

## Editor line length

We recommend to set markdown line length to 70 characters in your editor.
This way, it will match snippets line length in rendered articles.

Example of rendered snippet :

![When rendered a code snippet overflows at 70 characters](images/readme/iroco-blog-snippet-line-length-70-rendered.png)

The Markdown code of the page with line length set to 70 characters :

![In markdown editor with 70 character line length, the line marker matches the rendered length](images/readme/iroco-blog-snippet-line-length-70-markdown.png)

Jetbrains IDE markdown configuration sample.

![jetbrains configuration sample](images/readme/iroco-blog-jetbrains-markdown-config-sample.png)

- Hard wrap at : 70
- Wrap on typing : No
- Wrap long text : Unchecked
- Wrap text inside block quotes : Unchecked