Skip to content

Commit 7f19725

Browse files
committed
rewrite the documentation index page
Convert from HTML to Markdown to simplify extending the page. Mention the docs in mruby's source code and list (future) articles.
1 parent e1e27b7 commit 7f19725

File tree

2 files changed

+23
-13
lines changed

2 files changed

+23
-13
lines changed

docs/index.html

Lines changed: 0 additions & 13 deletions
This file was deleted.

docs/index.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
layout: default
3+
title: mruby - docs
4+
---
5+
6+
# Documentation
7+
8+
At the moment the source code ([`mruby/doc/`](https://github.com/mruby/mruby/tree/master/doc)) includes further documentation about compiling, configurating (`mrbconf`), debugging (`mrdb`), and extending (`mrbgems`) mruby.
9+
10+
## Articles
11+
12+
<div>
13+
{% for page in site.pages %}
14+
{% if page.categories contains 'articles' %}
15+
{% capture article %} - [{{ page.title }}]({{ page.url }}) {% endcapture %}
16+
{{ article | markdownify }}
17+
{% endif %}
18+
{% endfor %}
19+
</div>
20+
21+
## Components
22+
23+
- [Core](Core.html)

0 commit comments

Comments
 (0)