-
Notifications
You must be signed in to change notification settings - Fork 5.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Remove MkDocs copyright from documentation pages (#3072)
* Simplify MkDocs footer in documentation pages * Update plugins/techdocs/src/reader/transformers/simplifyMkdocsFooter.ts Co-authored-by: Emma Indal <emma.indahl@gmail.com> Co-authored-by: Emma Indal <emma.indahl@gmail.com>
- Loading branch information
Showing
4 changed files
with
67 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
38 changes: 38 additions & 0 deletions
38
plugins/techdocs/src/reader/transformers/simplifyMkdocsFooter.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
/* | ||
* Copyright 2020 Spotify AB | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
import { createTestShadowDom, FIXTURES } from '../../test-utils'; | ||
import { simplifyMkdocsFooter } from '.'; | ||
|
||
describe('simplifyMkdocsFooter', () => { | ||
it('does not remove mkdocs copyright', () => { | ||
const shadowDom = createTestShadowDom(FIXTURES.FIXTURE_STANDARD_PAGE, { | ||
preTransformers: [], | ||
postTransformers: [], | ||
}); | ||
|
||
expect(shadowDom.querySelector('.md-footer-copyright')).toBeTruthy(); | ||
}); | ||
|
||
it('does remove mkdocs copyright', () => { | ||
const shadowDom = createTestShadowDom(FIXTURES.FIXTURE_STANDARD_PAGE, { | ||
preTransformers: [simplifyMkdocsFooter()], | ||
postTransformers: [], | ||
}); | ||
|
||
expect(shadowDom.querySelector('.md-footer-copyright')).toBeFalsy(); | ||
}); | ||
}); |
26 changes: 26 additions & 0 deletions
26
plugins/techdocs/src/reader/transformers/simplifyMkdocsFooter.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
/* | ||
* Copyright 2020 Spotify AB | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
import type { Transformer } from './index'; | ||
|
||
export const simplifyMkdocsFooter = (): Transformer => { | ||
return dom => { | ||
// Remove mkdocs copyright | ||
dom.querySelector('.md-footer-copyright')?.remove(); | ||
|
||
return dom; | ||
}; | ||
}; |