Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve markdown formatting of pages, a lot of them are improperly formatted #2429

Merged
merged 26 commits into from Mar 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
e16735a
Revert "Revert "markdown format""
OniriCorpe Mar 1, 2024
018a2b4
fix formating
OniriCorpe Mar 1, 2024
c5a3e88
fix readme
OniriCorpe Mar 2, 2024
1e04815
add .markdownlint.json
OniriCorpe Mar 2, 2024
e122cb7
add markdownlint-rules-grav-pages
OniriCorpe Mar 2, 2024
0ff8dc5
add markdownlint-rules-grav-pages files
OniriCorpe Mar 2, 2024
fde58a9
add license for Markdown Lint Rules for Grav Pages
OniriCorpe Mar 2, 2024
a73bb26
fix [figure] mess
OniriCorpe Mar 2, 2024
d9f5bd2
fix [figure] mess 2
OniriCorpe Mar 2, 2024
47d486e
fix [figure] mess 3
OniriCorpe Mar 2, 2024
3780671
maj .gitignore
OniriCorpe Mar 2, 2024
36fed78
various fixes
OniriCorpe Mar 2, 2024
b190487
fix markdownlint-rules-grav-pages
OniriCorpe Mar 2, 2024
a9774ac
second formater pass
OniriCorpe Mar 2, 2024
6d4b2d2
various manual fixes
OniriCorpe Mar 2, 2024
cd16923
add .markdownlintignore
OniriCorpe Mar 2, 2024
a3cd4bd
Merge branch 'master' into revert-2428-revert-2427-markdown-format
OniriCorpe Mar 2, 2024
ef87aec
markdownlintignore: auto-generated pages
OniriCorpe Mar 2, 2024
20fe754
Merge branch 'revert-2428-revert-2427-markdown-format' of https://git…
OniriCorpe Mar 2, 2024
5957534
Merge branch 'master' into revert-2428-revert-2427-markdown-format
OniriCorpe Mar 2, 2024
d15b3d5
disable proper-names for html_elements
OniriCorpe Mar 7, 2024
4e21c56
another bunch of various markdown fixes
OniriCorpe Mar 7, 2024
a54e2e4
Merge branch 'master' into revert-2428-revert-2427-markdown-format
OniriCorpe Mar 12, 2024
0cef5f2
Merge branch 'master' into revert-2428-revert-2427-markdown-format
OniriCorpe Mar 13, 2024
4a0feec
Update pages/02.administer/10.install/20.dns_config/dns_config.es.md
alexAubin Mar 19, 2024
1c7b379
Merge branch 'master' into revert-2428-revert-2427-markdown-format
OniriCorpe Mar 23, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 2 additions & 0 deletions .gitignore
@@ -1,7 +1,9 @@
/*
!.github
!/pages
!/images
!/themes
!/Dockerfile
!/docker-compose.yml
!/dev/plugins
!/markdownlint-rules-grav-pages
64 changes: 64 additions & 0 deletions .markdownlint.json
@@ -0,0 +1,64 @@
{
"extends": "markdownlint-rules-grav-pages/rules/frontmatter.schema.json",
"default": true,
"code-block-style": {
"style": "fenced"
},
"code-fence-style": {
"style": "backtick"
},
"emphasis-style": {
"style": "asterisk"
},
"strong-style": {
"style": "asterisk"
},
"ul-style": {
"style": "dash"
},
"ul-indent": {
"indent": 2
},
"heading-style": {
"style": "atx"
},
"no-duplicate-heading": {
"siblings_only": true
},
"hr-style": {
"style": "---"
},
"ol-prefix": {
"style": "ordered"
},
"no-trailing-punctuation": {
"punctuation": ".,;:"
},
"no-inline-html": false,
"fenced-code-language": {
"allowed_languages": [
"bash",
"html",
"css",
"javascript",
"php",
"json",
"yaml",
"toml",
"markdown",
"text"
],
"language_only": true
},
"proper-names": {
"code_blocks": false,
"html_elements": false,
"names": [
"YunoHost",
"GitHub"
]
},
"line-length": false,
"no-reversed-links": false,
"no-missing-space-atx": false
}
11 changes: 11 additions & 0 deletions .markdownlintignore
@@ -0,0 +1,11 @@
config
images
tests
themes
.*
Dockerfile
docker-compose.yml

# auto-generated pages
pages/06.contribute/10.packaging_apps/80.resources/11.helpers/packaging_apps_helpers.md
pages/06.contribute/10.packaging_apps/80.resources/15.appresources/packaging_apps_resources.md
14 changes: 7 additions & 7 deletions README.md
@@ -1,32 +1,32 @@
# YunoHost Documentation

* [Web Site](https://yunohost.org)
* Based on [Grav](https://getgrav.org/)
- [Web Site](https://yunohost.org)
- Based on [Grav](https://getgrav.org/)

Please report [issues on YunoHost bugtracker](https://github.com/YunoHost/issues/issues).

## Note about package documentation
## Note on package documentation

Package documentation should be done in the package repository itself, under the `/doc` folder.
You can learn about it here: <https://yunohost.org/packaging_app_doc>

# Contributing
## Contributing

This repo use a **submodule** to provide the theme. So when you clone use:

```shell
```bash
git clone --recursive https://github.com/YunoHost/doc.git
```

You can refer to the page on [writing documentation](https://yunohost.org/write_documentation).

If you know docker, you can run:

```
```bash
docker-compose up
```

## Regenerate the CSS
### Regenerate the CSS

We use scss to manage the CSS. If you want to change it, you must rebuild it.

Expand Down
10 changes: 10 additions & 0 deletions markdownlint-rules-grav-pages/.eslintrc
@@ -0,0 +1,10 @@
{
"extends": "airbnb-base",
"rules": {
"no-empty": ["error", { "allowEmptyCatch": true }],
"prefer-rest-params": "off",
"prefer-spread": "off",
"strict": "off",
"indent": ["error", 4]
}
}
2 changes: 2 additions & 0 deletions markdownlint-rules-grav-pages/.gitignore
@@ -0,0 +1,2 @@
/node_modules/
/.idea
9 changes: 9 additions & 0 deletions markdownlint-rules-grav-pages/.travis.yml
@@ -0,0 +1,9 @@
language: node_js
node_js:
- "8"
- "9"
- "10"
- "11"
script:
- npm run lint
- npm run test
79 changes: 79 additions & 0 deletions markdownlint-rules-grav-pages/CHANGELOG.md
@@ -0,0 +1,79 @@
# Changelog

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

### [1.0.19](https://github.com/syseleven/markdownlint-rules-grav-pages/compare/v1.0.18...v1.0.19) (2022-05-18)

### [1.0.18](https://github.com/syseleven/markdownlint-rules-grav-pages/compare/v1.0.17...v1.0.18) (2022-02-08)

### [1.0.17](https://github.com/syseleven/markdownlint-rules-grav-pages/compare/v1.0.16...v1.0.17) (2022-02-03)

### [1.0.16](https://github.com/syseleven/markdownlint-rules-grav-pages/compare/v1.0.15...v1.0.16) (2020-03-15)

### [1.0.15](https://github.com/syseleven/markdownlint-rules-grav-pages/compare/v1.0.14...v1.0.15) (2019-12-30)

### [1.0.14](https://github.com/syseleven/markdownlint-rules-grav-pages/compare/v1.0.13...v1.0.14) (2019-07-11)



### [1.0.13](https://github.com/syseleven/markdownlint-rules-grav-pages/compare/v1.0.12...v1.0.13) (2019-05-10)



<a name="1.0.12"></a>
### [1.0.12](https://github.com/syseleven/markdownlint-rules-grav-pages/compare/v1.0.11...v1.0.12) (2019-02-14)



<a name="1.0.11"></a>
### [1.0.11](https://github.com/syseleven/markdownlint-rules-grav-pages/compare/v1.0.10...v1.0.11) (2018-12-04)



<a name="1.0.10"></a>
### [1.0.10](https://github.com/syseleven/markdownlint-rules-grav-pages/compare/v1.0.9...v1.0.10) (2018-10-23)



<a name="1.0.9"></a>
### [1.0.9](https://github.com/syseleven/markdownlint-rules-grav-pages/compare/v1.0.8...v1.0.9) (2018-10-03)



<a name="1.0.8"></a>
### [1.0.8](https://github.com/syseleven/markdownlint-rules-grav-pages/compare/v1.0.7...v1.0.8) (2018-09-14)



<a name="1.0.7"></a>
### [1.0.7](https://github.com/syseleven/markdownlint-rules-grav-pages/compare/v1.0.6...v1.0.7) (2018-08-28)



<a name="1.0.6"></a>
### [1.0.6](https://github.com/syseleven/markdownlint-rules-grav-pages/compare/v1.0.5...v1.0.6) (2018-08-28)



<a name="1.0.5"></a>
### [1.0.5](https://github.com/syseleven/markdownlint-rules-grav-pages/compare/v1.0.4...v1.0.5) (2018-08-20)



<a name="1.0.4"></a>
### [1.0.4](https://github.com/syseleven/markdownlint-rules-grav-pages/compare/v1.0.3...v1.0.4) (2018-08-09)



<a name="1.0.3"></a>
### [1.0.3](https://github.com/syseleven/markdownlint-rules-grav-pages/compare/v1.0.2...v1.0.3) (2018-08-09)



<a name="1.0.2"></a>
### [1.0.2](https://github.com/syseleven/markdownlint-rules-grav-pages/compare/v1.0.1...v1.0.2) (2018-07-30)



<a name="1.0.1"></a>
### 1.0.1 (2018-07-19)
24 changes: 24 additions & 0 deletions markdownlint-rules-grav-pages/LICENSE
@@ -0,0 +1,24 @@
Copyright (c) 2016, SysEleven GmbH
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name of the SysEleven GmbH nor the
names of its contributors may be used to endorse or promote products
derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL SYSELEVEN GMBH BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44 changes: 44 additions & 0 deletions markdownlint-rules-grav-pages/README.md
@@ -0,0 +1,44 @@
# Markdown Lint Rules for Grav Pages

[![Build Status](https://travis-ci.org/syseleven/markdownlint-rules-grav-pages.svg?branch=master)](https://travis-ci.org/syseleven/markdownlint-rules-grav-pages)

This package contains additional linting rules for [markdownlint](https://github.com/DavidAnson/markdownlint)
that check if a Markdown file is a valid [Grav CMS](https://getgrav.org/) page.

## Rules

### valid-images

* Checks if a relatively referenced image is present.

### valid-internal-links

* Checks if a link to a another markdown file in the same repo is correct.

### valid-metadata-block

* Checks if a Frontmatter metadata block is present and valid.

## Usage

See https://github.com/DavidAnson/markdownlint/blob/master/doc/CustomRules.md

## Development

To lint all source files run:

```bash
$ npm run lint
```

To run all tests:

```bash
$ npm run test
```

To release a new version, ensure that the checkout is clean, then run:

```bash
$ npm run release && git push --follow-tags origin master && npm publish
```
10 changes: 10 additions & 0 deletions markdownlint-rules-grav-pages/lib/flat.js
@@ -0,0 +1,10 @@
module.exports = function flat(array) {
let result = [];
array.forEach((a) => {
result.push(a);
if (Array.isArray(a.children)) {
result = result.concat(flat(a.children));
}
});
return result;
};