summaryrefslogtreecommitdiffstats
path: root/FAQ.md
diff options
context:
space:
mode:
authorDr. Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>2019-11-28 23:10:51 +0100
committerDr. Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>2020-02-26 21:04:38 +0100
commit5f8e6c50bd862d6bb0bbd16b4c0b3be841d9cf32 (patch)
tree41e6e7047573f760fcdf195560ccf57d672aea7f /FAQ.md
parent2e07506a12e126894cd820304465162bc0e732b4 (diff)
doc: introduce some minimalistic markdown without essential changes
The goal is to transform the standard documents README, INSTALL, SUPPORT, CONTRIBUTING, ... from a pure text format into markdown format, but in such a way that the documentation remains nicely formatted an easy readable when viewed with an normal text editor. To achieve this goal, we use a special form of 'minimalistic' markdown which interferes as little as possible with the reading flow. * avoid [ATX headings][] and use [setext headings][] instead (works for `<h1>` and `<h2>` headings only). * avoid [inline links][] and use [reference links][] instead. * avoid [fenced code blocks][], use [indented-code-blocks][] instead. The transformation will take place in several steps. This commit introduces mostly changes the formatting and does not chang the content significantly. [ATX headings]: https://github.github.com/gfm/#atx-headings [setext headings]: https://github.github.com/gfm/#setext-headings [inline links]: https://github.github.com/gfm/#inline-link [reference links]: https://github.github.com/gfm/#reference-link [fenced code blocks]: https://github.github.com/gfm/#fenced-code-blocks [indented code blocks]: https://github.github.com/gfm/#indented-code-blocks Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> (Merged from https://github.com/openssl/openssl/pull/10545)
Diffstat (limited to 'FAQ.md')
-rw-r--r--FAQ.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/FAQ.md b/FAQ.md
index 22c5cf7dc2..30f5010ce3 100644
--- a/FAQ.md
+++ b/FAQ.md
@@ -1,2 +1,6 @@
-The FAQ is now maintained on the web:
- https://www.openssl.org/docs/faq.html
+Frequently Asked Questions (FAQ)
+================================
+
+The [Frequently Asked Questions][FAQ] are now maintained on the OpenSSL homepage.
+
+ [FAQ]: https://www.openssl.org/docs/faq.html