Skip to content

Commit ecf8f05

Browse files
committed
docs(readme,blog): fix markdown linting errors
1 parent 91f5957 commit ecf8f05

File tree

2 files changed

+12
-7
lines changed

2 files changed

+12
-7
lines changed

README.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
1-
# zealdocs.github.io
2-
https://zealdocs.org/: web documentation for [Zeal, an offline documentation browser][zeal].
1+
# zealdocs.github.io / zealdocs.org
2+
3+
This repository contains source code the [Zeal][zeal] homepage.
34

45
## Development
6+
57
To build this static site, you need the following dependencies:
8+
69
- `jekyll` (`v3.1.6` from Ubuntu 18.04 works correctly)
710

811
To perform a one-off build, run:
12+
913
```sh
1014
jekyll build
1115
```
1216

1317
To build any time a source code file changes and locally host the results at `http://127.0.0.1:4000/`, run:
18+
1419
```sh
1520
jekyll serve
1621
```

_posts/2015-05-01-post-0.1-release-thoughts.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ I've instantly fell in love in Dash's quick search functionality which allows ea
1111

1212
While I don't really spend much time on developing Zeal nowadays, all the hard work is mostly done by [@trollixx](https://github.com/trollixx), but I try to support him when I can, and we talk a lot about potential long term goals for Zeal. Some of possibilities from the top of my head:
1313

14-
- Tons of new features to implement, like [full text search](https://github.com/zealdocs/zeal/issues/280), [docsets versioning](https://github.com/zealdocs/zeal/issues/208), [autogenerated docs](https://github.com/zealdocs/zeal/issues/143), [support for Dash's user contributed docs](https://github.com/zealdocs/zeal/issues/170), and more.
15-
- Spend more time on community, which could involve Twitter posts, writing blog with status updates and release plans, improving the website, etc.
16-
- Possibly derive some business model which would allow funding Zeal's development - note there was *no* money involved in Zeal's development yet! The ideas include supporting software businesses' documentation needs, or selling books from Zeal's UI... However, the plan is to always keep Zeal an open source project.
17-
- Build a backend servers infrastructure for things like cross-device settings synchronization, crash reporting, history, statistics.
18-
- Create a community of developers where everyone can contribute to documentation and help others, a bit like StackExchange, but more centered on documentation.
14+
- Tons of new features to implement, like [full text search](https://github.com/zealdocs/zeal/issues/280), [docsets versioning](https://github.com/zealdocs/zeal/issues/208), [autogenerated docs](https://github.com/zealdocs/zeal/issues/143), [support for Dash's user contributed docs](https://github.com/zealdocs/zeal/issues/170), and more.
15+
- Spend more time on community, which could involve Twitter posts, writing blog with status updates and release plans, improving the website, etc.
16+
- Possibly derive some business model which would allow funding Zeal's development - note there was *no* money involved in Zeal's development yet! The ideas include supporting software businesses' documentation needs, or selling books from Zeal's UI... However, the plan is to always keep Zeal an open source project.
17+
- Build a backend servers infrastructure for things like cross-device settings synchronization, crash reporting, history, statistics.
18+
- Create a community of developers where everyone can contribute to documentation and help others, a bit like StackExchange, but more centered on documentation.
1919

2020
This is all obviously very far-fetched, and requires lots of effort to implement even part of the ideas, but I think it's a very exciting project to take part in!
2121

0 commit comments

Comments
 (0)