Permalink
Browse files

Documentation: Remove trailing `#` characters

We remove trailing `#` characters at the right hand side of headings,
since the Markdown syntax [1] does not require them at all.

[1]: https://daringfireball.net/projects/markdown/syntax#header
  • Loading branch information...
sanssecours committed Feb 12, 2017
1 parent 32ba887 commit 59e4561d42e3bd0e06ca5b12cea4a539e31e456b
Showing with 1,103 additions and 1,103 deletions.
  1. +6 −6 .github/CONTRIBUTING.md
  2. +17 −17 README.md
  3. +8 −8 doc/API.md
  4. +27 −27 doc/AUTHORS.md
  5. +3 −3 doc/BIGPICTURE.md
  6. +12 −12 doc/CODING.md
  7. +31 −31 doc/COMPILE.md
  8. +11 −11 doc/DESIGN.md
  9. +7 −7 doc/GIT.md
  10. +4 −4 doc/GOALS.md
  11. +5 −5 doc/IDEAS.md
  12. +10 −10 doc/INSTALL.md
  13. +2 −2 doc/LICENSE.md
  14. +4 −4 doc/SECURITY.md
  15. +15 −15 doc/TESTING.md
  16. +3 −3 doc/VERSION.md
  17. +6 −6 doc/WHY.md
  18. +10 −10 doc/decisions/api_documentation.md
  19. +10 −10 doc/decisions/bool.md
  20. +10 −10 doc/decisions/global_validation.md
  21. +17 −17 doc/decisions/high_level_api.md
  22. +10 −10 doc/decisions/template.md
  23. +9 −9 doc/help/elektra-architecture.md
  24. +3 −3 doc/help/elektra-bootstrapping.md
  25. +9 −9 doc/help/elektra-faq.md
  26. +1 −1 doc/help/kdb-shell.md
  27. +1 −1 doc/images/README.md
  28. +8 −8 doc/markdownlinkconverter/README.md
  29. +7 −7 doc/news/2014-06-21_0.8.6.md
  30. +7 −7 doc/news/2014-07-28_0.8.7.md
  31. +7 −7 doc/news/2014-09-02_0.8.8.md
  32. +1 −1 doc/news/2014-10-22_augeas.md
  33. +8 −8 doc/news/2014-11-04_0.8.9.md
  34. +13 −13 doc/news/2014-12-02_0.8.10.md
  35. +19 −19 doc/news/2015-04-03_0.8.11.md
  36. +11 −11 doc/news/2015-07-13_0.8.12.md
  37. +13 −13 doc/news/2015-09-17_0.8.13.md
  38. +23 −23 doc/news/2015-11-19_0.8.14.md
  39. +23 −23 doc/news/2016-02-16_0.8.15.md
  40. +34 −34 doc/news/2016-04-29_0.8.16.md
  41. +22 −22 doc/news/2016-06-14_0.8.17.md
  42. +18 −18 doc/news/2016-09-17_0.8.18.md
  43. +18 −18 doc/news/2016-11-22_0.8.19.md
  44. +11 −11 doc/news/2016-12-17_website_release.md
  45. +5 −5 doc/old/CHANGES.0.8.md
  46. +6 −6 doc/old/NEWS.md
  47. +1 −1 doc/paper/README.md
  48. +10 −10 doc/todo/NEWS.md
  49. +7 −7 doc/tutorials/application-integration.md
  50. +9 −9 doc/tutorials/cascading.md
  51. +2 −2 doc/tutorials/compilation-variants.md
  52. +6 −6 doc/tutorials/elektra-merge-integration.md
  53. +5 −5 doc/tutorials/export.md
  54. +6 −6 doc/tutorials/import.md
  55. +10 −10 doc/tutorials/merge.md
  56. +7 −7 doc/tutorials/mount.md
  57. +6 −6 doc/tutorials/namespaces.md
  58. +15 −15 doc/tutorials/plugins.md
  59. +4 −4 doc/tutorials/python-kdb.md
  60. +24 −24 doc/tutorials/snippet-sharing-rest-service.md
  61. +7 −7 doc/tutorials/validation.md
  62. +5 −5 doc/usecases/snippet_sharing/distinction_use_cases.md
  63. +3 −3 doc/usecases/template.md
  64. +4 −4 scripts/README.md
  65. +2 −2 src/bindings/README.md
  66. +4 −4 src/bindings/cpp/README.md
  67. +2 −2 src/bindings/gi/lua/README.md
  68. +2 −2 src/bindings/gi/python/README.md
  69. +1 −1 src/bindings/glib/README.md
  70. +18 −18 src/bindings/gsettings/README.md
  71. +4 −4 src/bindings/intercept/fs/README.md
  72. +3 −3 src/bindings/jna/README.md
  73. +3 −3 src/bindings/swig/lua/README.md
  74. +3 −3 src/bindings/swig/python/README.md
  75. +4 −4 src/bindings/swig/python2/README.md
  76. +11 −11 src/bindings/swig/ruby/README.md
  77. +8 −8 src/libs/README.md
  78. +14 −14 src/plugins/README.md
  79. +8 −8 src/plugins/augeas/README.md
  80. +2 −2 src/plugins/base64/README.md
  81. +5 −5 src/plugins/blockresolver/README.md
  82. +2 −2 src/plugins/boolean/README.md
  83. +1 −1 src/plugins/c/README.md
  84. +2 −2 src/plugins/cachefilter/README.md
  85. +4 −4 src/plugins/ccode/README.md
  86. +10 −10 src/plugins/conditionals/README.md
  87. +2 −2 src/plugins/constants/README.md
  88. +2 −2 src/plugins/counter/README.md
  89. +12 −12 src/plugins/crypto/README.md
  90. +4 −4 src/plugins/csvstorage/README.md
  91. +8 −8 src/plugins/curlget/README.md
  92. +4 −4 src/plugins/date/README.md
  93. +9 −9 src/plugins/dbus/README.md
  94. +3 −3 src/plugins/desktop/README.md
  95. +2 −2 src/plugins/doc/README.md
  96. +1 −1 src/plugins/dpkg/README.md
  97. +5 −5 src/plugins/dump/README.md
  98. +3 −3 src/plugins/enum/README.md
  99. +4 −4 src/plugins/error/README.md
  100. +9 −9 src/plugins/fcrypt/README.md
  101. +2 −2 src/plugins/filecheck/README.md
  102. +4 −4 src/plugins/fstab/README.md
  103. +4 −4 src/plugins/gitresolver/README.md
  104. +5 −5 src/plugins/glob/README.md
  105. +4 −4 src/plugins/hexcode/README.md
  106. +1 −1 src/plugins/hidden/README.md
  107. +9 −9 src/plugins/hosts/README.md
  108. +3 −3 src/plugins/iconv/README.md
  109. +8 −8 src/plugins/ini/README.md
  110. +1 −1 src/plugins/iterate/README.md
  111. +9 −9 src/plugins/jni/README.md
  112. +2 −2 src/plugins/journald/README.md
  113. +8 −8 src/plugins/keytometa/README.md
  114. +4 −4 src/plugins/line/README.md
  115. +2 −2 src/plugins/lineendings/README.md
  116. +3 −3 src/plugins/list/README.md
  117. +2 −2 src/plugins/logchange/README.md
  118. +5 −5 src/plugins/lua/README.md
  119. +3 −3 src/plugins/mathcheck/README.md
  120. +5 −5 src/plugins/mozprefs/README.md
  121. +8 −8 src/plugins/mozprefs/autoconfig/README.md
  122. +3 −3 src/plugins/network/README.md
  123. +3 −3 src/plugins/ni/README.md
  124. +1 −1 src/plugins/noresolver/README.md
  125. +3 −3 src/plugins/null/README.md
  126. +5 −5 src/plugins/passwd/README.md
  127. +3 −3 src/plugins/path/README.md
  128. +2 −2 src/plugins/profile/README.md
  129. +6 −6 src/plugins/python/README.md
  130. +1 −1 src/plugins/python2/README.md
  131. +5 −5 src/plugins/regexstore/README.md
  132. +12 −12 src/plugins/rename/README.md
  133. +3 −3 src/plugins/required/README.md
  134. +5 −5 src/plugins/resolver/README.md
  135. +2 −2 src/plugins/semlock/README.md
  136. +2 −2 src/plugins/shell/README.md
  137. +5 −5 src/plugins/simpleini/README.md
  138. +4 −4 src/plugins/simplespeclang/README.md
  139. +8 −8 src/plugins/spec/README.md
  140. +5 −5 src/plugins/struct/README.md
  141. +2 −2 src/plugins/sync/README.md
  142. +1 −1 src/plugins/syslog/README.md
  143. +4 −4 src/plugins/tcl/README.md
  144. +5 −5 src/plugins/template/README.md
  145. +3 −3 src/plugins/timeofday/README.md
  146. +3 −3 src/plugins/tracer/README.md
  147. +3 −3 src/plugins/type/README.md
  148. +4 −4 src/plugins/uname/README.md
  149. +5 −5 src/plugins/validation/README.md
  150. +1 −1 src/plugins/wresolver/README.md
  151. +4 −4 src/plugins/xmltool/README.md
  152. +6 −6 src/plugins/yajl/README.md
  153. +4 −4 src/tools/gen/README.md
  154. +8 −8 src/tools/qt-gui/README.md
  155. +14 −14 src/tools/rest-backend/README.md
  156. +3 −3 src/tools/rest-backend/benchmarks/README.md
  157. +33 −33 src/tools/rest-frontend/README.md
  158. +11 −11 tests/shell/shell_recorder/README.md
  159. +2 −2 tests/shell/shell_recorder/tutorial_wrapper/README.md
View
@@ -1,4 +1,4 @@
# Documentation #
# Documentation
We use a fork and pull model, you can read about
[forking repos at github help](https://help.github.com/articles/fork-a-repo/).
@@ -8,7 +8,7 @@ or README.md can be done without any further considerations!
Simply do the fixes in your cloned repo and create a pull request.
# Issues #
# Issues
If you have any questions you can ask them using
[github issue](https://github.com/ElektraInitiative/libelektra/issues/new).
@@ -18,15 +18,15 @@ See also [FAQ](/doc/help/elektra-faq.md) for some details
about creating issues.
# General #
# General
We recommend that you read:
- [The big picture what Elektra is](/doc/BIGPICTURE.md)
- [The tutorials to get some practice](/doc/tutorials/)
# Code #
# Code
Before you issue a pull request that modifies code:
@@ -35,7 +35,7 @@ Before you issue a pull request that modifies code:
- Make sure you fulfilled the [definition of done](/.github/PULL_REQUEST_TEMPLATE.md).
# Architecture #
# Architecture
Before you start making fundamental changes:
@@ -45,7 +45,7 @@ Before you start making fundamental changes:
to keep the discussion more efficient and architecture documented.
# Labels #
# Labels
- If you do not want your PR to be merged, please label
the PR with the label "work in progress".
View
@@ -1,4 +1,4 @@
# libelektra #
# libelektra
_Elektra serves as a universal and secure framework to access configuration
parameters in a global, hierarchical key database._
@@ -11,13 +11,13 @@ and tools regarding configuration tasks. Elektra abstracts from
cross-platform-related issues and allows applications to be aware of other
applications' configurations, leveraging easy application integration.
## Often used links ##
## Often used links
- [build server](https://build.libelektra.org/)
- [tutorials](/doc/tutorials/)
- [API docu](https://doc.libelektra.org/api/latest/html/)
## Overview ##
## Overview
Elektra consists of three parts:
@@ -55,19 +55,19 @@ implemented in C, works cross-platform, and does not need any external dependenc
- [Big Picture of Elektra](doc/BIGPICTURE.md)
## Contact ##
## Contact
Do not hesitate to ask any question on
[GitHub issue tracker](https://issues.libelektra.org/),
[Mailing List](https://lists.sourceforge.net/lists/listinfo/registry-list)
or directly to one of the [authors](doc/AUTHORS.md).
## Quickstart ##
## Quickstart
If you want to use Elektra for your application, [read the application integration tutorial](doc/tutorials/application-integration.md).
### Installation ###
### Installation
The preferred way to install Elektra is by using packages provided for
your distribution. On Debian/Ubuntu, this can be done by running the following
@@ -87,7 +87,7 @@ It is preferable to use a recent version: They contain many bug fixes and
additional features. See [INSTALL](doc/INSTALL.md) for other ways to install
Elektra.
### Usage ###
### Usage
Now that we have Elektra installed, we can start using the [kdb command](/doc/help/kdb.md) and
the [qt-gui](/src/tools/qt-gui/).
@@ -101,7 +101,7 @@ For information about elektrified environment variables, see
[/src/libgetenv/README.md](/src/libs/getenv/README.md)
### Documentation ###
### Documentation
To get an idea of Elektra, you can take a look at the
@@ -126,7 +126,7 @@ You can read the documentation for the kdb tool, either
## Goals ##
## Goals
- Make it trivial for applications and administrators to access
any configuration
@@ -148,7 +148,7 @@ And in terms of quality, we want:
[Read more about the goals of Elektra](doc/GOALS.md)
## Facts and Features ##
## Facts and Features
* Elektra uses the [BSD licence](doc/LICENSE.md).
* Elektra implements an [API](http://doc.libelektra.org/api/latest/html/) to fully access a global key database.
@@ -170,14 +170,14 @@ And in terms of quality, we want:
* Elektra provides powerful [Code Generation Techniques](src/tools/gen) for high-level configuration access.
## News ##
## News
Go to the [website](https://www.libelektra.org), see [News](doc/news/), and its [RSS feed](https://www.libelektra.org/news/feed.rss).
## Sources ##
## Sources
### Packages ###
### Packages
The preferred way to install Elektra is by using packages provided for
your distribution, see [INSTALL](/doc/INSTALL.md) for available packages.
@@ -188,7 +188,7 @@ For macOS there is a homebrew tap available:
If there are no packages available for your distribution see the
[installation document](doc/INSTALL.md).
### Download ###
### Download
Elektra's uses a [git repository at GitHub](https://github.com/ElektraInitiative/libelektra).
@@ -199,7 +199,7 @@ You can clone the latest version of Elektra by running:
Releases can be downloaded from [http](https://www.libelektra.org/ftp/elektra/releases/) and
`ftp://ftp.libelektra.org/elektra/releases/`
### Compiling ###
### Compiling
After downloading or cloning Elektra, `cd` to the directory and run the
following commands to compile it:
@@ -216,14 +216,14 @@ For more information, especially how to set CMake Cache, see [here](doc/COMPILE.
Make sure to read how to add plugins, tools and bindings.
## Build Server ##
## Build Server
The [build server](https://build.libelektra.org/) builds
Elektra on every commit in various ways and also produces [LCOV code
coverage report](http://doc.libelektra.org/coverage/latest).
## Contributing ##
## Contributing
To start development, just clone the repo and start hacking!
We prepared [beginner friendly tasks](https://github.com/ElektraInitiative/libelektra/issues?q=is%3Aissue+is%3Aopen+label%3A%22beginner+friendly%22)
View
@@ -1,4 +1,4 @@
## Elektra Initiative Overview ##
## Elektra Initiative Overview
Elektra serves as a universal and secure framework to access configuration
parameters in a global, hierarchical key database and provides a mature,
@@ -12,7 +12,7 @@ See the [readme](/README.md) for more introduction.
See the [glossary](/doc/help/elektra-glossary.md) for the used
terminology.
## API Docu ##
## API Docu
This document's main goal is to describe the API.
It covers:
@@ -38,7 +38,7 @@ http://doc.libelektra.org/api/latest/html
**Important:** On github links to API functions are broken, so it is recommended that you continue
reading in one of these links above.
## Using the Elektra Library ##
## Using the Elektra Library
A C or C++ source file that wants to use Elektra should include:
@@ -57,7 +57,7 @@ Another way is to use CMake:
Read about [compiling elektra](/doc/COMPILE.md).
### Tutorials ###
### Tutorials
* [Application Integration](/doc/tutorials/application-integration.md)
* [Compilation Variants](/doc/tutorials/compilation-variants.md)
@@ -71,7 +71,7 @@ Read about [compiling elektra](/doc/COMPILE.md).
[List of all available Plugins](/src/plugins/) and get started by developing
your own plugins @ref plugin.
## Elektra API ##
## Elektra API
The API was written in pure C because Elektra was designed to be useful
even for the most basic system programs.
@@ -109,7 +109,7 @@ entire [KeySet](@ref ksAppend)
[More background information about the classes](/doc/help/elektra-classes.md)
## Namespaces ##
## Namespaces
There are 5 trees (=namespaces) of keys: `spec`, `proc`, `dir`, `user` and `system`
that are all unified (in the given order) in one cascading tree starting with `/`.
@@ -155,7 +155,7 @@ daemons and system services.
Read more about [namespaces](/doc/help/elektra-namespaces.md)
and a tutorial for [namespaces](/doc/tutorials/namespaces.md).
## Rules for Key Names ##
## Rules for Key Names
When using Elektra to store your application's configuration and state,
please keep in mind the following rules:
@@ -173,7 +173,7 @@ They are reserved for more generic purposes.
Read more about [key names](/doc/help/elektra-key-names.md)
## Backend Overview ##
## Backend Overview
The core of Elektra does not store configuration itself to the
harddisk. Instead this work is delegated to backends.
Oops, something went wrong.

0 comments on commit 59e4561

Please sign in to comment.