mirror of
https://github.com/DSpace/dspace-angular.git
synced 2025-10-07 01:54:15 +00:00
Move generated documentation to docs/lint/
This commit is contained in:
1
lint/.gitignore
vendored
1
lint/.gitignore
vendored
@@ -1,4 +1,3 @@
|
||||
/dist/
|
||||
/coverage/
|
||||
/node-modules/
|
||||
/docs/
|
||||
|
@@ -5,8 +5,8 @@ Custom ESLint rules for DSpace Angular peculiarities.
|
||||
## Documentation
|
||||
|
||||
The rules are split up into plugins by language:
|
||||
- [TypeScript rules](./docs/ts/index.md)
|
||||
- [HTML rules](./docs/html/index.md)
|
||||
- [TypeScript rules](../docs/lint/ts/index.md)
|
||||
- [HTML rules](../docs/lint/html/index.md)
|
||||
|
||||
> Run `yarn docs:lint` to generate this documentation!
|
||||
|
||||
|
@@ -28,7 +28,7 @@ function lazyEJS(path: string, data: object) {
|
||||
return templates.get(path)(data);
|
||||
}
|
||||
|
||||
const docsDir = join('lint', 'docs');
|
||||
const docsDir = join('docs', 'lint');
|
||||
const tsDir = join(docsDir, 'ts');
|
||||
const htmlDir = join(docsDir, 'html');
|
||||
|
||||
|
@@ -1,4 +1,4 @@
|
||||
[DSpace ESLint plugins](../../README.md) > <%= plugin.language %> rules
|
||||
[DSpace ESLint plugins](../../../lint/README.md) > <%= plugin.language %> rules
|
||||
|
||||
<% rules.forEach(rule => { %>
|
||||
- [`<%= plugin.name %>/<%= rule.name %>`](./rules/<%= rule.name %>.md)<% if (rule.meta?.docs?.description) {%>: <%= rule.meta.docs.description.split('\n')[0] %><% }%>
|
||||
|
@@ -1,11 +1,11 @@
|
||||
[DSpace ESLint plugins](../../../README.md) > [<%= plugin.language %> rules](../index.md) > `<%= plugin.name %>/<%= rule.name %>`
|
||||
[DSpace ESLint plugins](../../../../lint/README.md) > [<%= plugin.language %> rules](../index.md) > `<%= plugin.name %>/<%= rule.name %>`
|
||||
_______
|
||||
|
||||
<%- rule.meta.docs?.description %>
|
||||
|
||||
_______
|
||||
|
||||
[Source code](../../../src/rules/<%- plugin.name.replace('dspace-angular-', '') %>/<%- rule.name %>.ts)
|
||||
[Source code](../../../../lint/src/rules/<%- plugin.name.replace('dspace-angular-', '') %>/<%- rule.name %>.ts)
|
||||
|
||||
### Examples
|
||||
|
||||
|
Reference in New Issue
Block a user