Skip to content

Commit

Permalink
Remove MkDocs copyright from documentation pages (#3072)
Browse files Browse the repository at this point in the history
* 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
canut and emmaindal committed Oct 26, 2020
1 parent 675bb23 commit 8de84c7
Show file tree
Hide file tree
Showing 4 changed files with 67 additions and 0 deletions.
2 changes: 2 additions & 0 deletions plugins/techdocs/src/reader/components/Reader.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ import transformer, {
rewriteDocLinks,
addLinkClickListener,
removeMkdocsHeader,
simplifyMkdocsFooter,
modifyCss,
onCssReady,
sanitizeDOM,
Expand Down Expand Up @@ -81,6 +82,7 @@ export const Reader = ({ entityId, onReady }: Props) => {
},
}),
removeMkdocsHeader(),
simplifyMkdocsFooter(),
injectCss({
css: `
body {
Expand Down
1 change: 1 addition & 0 deletions plugins/techdocs/src/reader/transformers/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ export * from './addBaseUrl';
export * from './rewriteDocLinks';
export * from './addLinkClickListener';
export * from './removeMkdocsHeader';
export * from './simplifyMkdocsFooter';
export * from './modifyCss';
export * from './onCssReady';
export * from './sanitizeDOM';
Expand Down
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 plugins/techdocs/src/reader/transformers/simplifyMkdocsFooter.ts
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;
};
};

0 comments on commit 8de84c7

Please sign in to comment.