Skip to content

Commit 439c794

Browse files
authored
chore(docs): add docs/snippets to npm workspace (#1251)
* chore: add docs/snippets folder to npm workspace * chore: added mkdocs plugin to exclude node_modules dir from docs * chore: housekeeping
1 parent 53a1705 commit 439c794

File tree

6 files changed

+146
-1210
lines changed

6 files changed

+146
-1210
lines changed

Diff for: docs/Dockerfile

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
FROM squidfunk/mkdocs-material
2-
RUN pip install mkdocs-git-revision-date-plugin mkdocs-glightbox
2+
RUN pip install mkdocs-git-revision-date-plugin==0.3.2 mkdocs-exclude==1.0.2

Diff for: docs/requirements.txt

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
mike==1.1.2
22
mkdocs-material==9.0.2
3-
mkdocs-git-revision-date-plugin==0.3.2
3+
mkdocs-git-revision-date-plugin==0.3.2
4+
mkdocs-exclude==1.0.2

Diff for: docs/snippets/package.json

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
{
2+
"name": "docs",
3+
"version": "0.0.1",
4+
"description": "A collection code snippets for the AWS Lambda Powertools for TypeScript docs",
5+
"author": {
6+
"name": "Amazon Web Services",
7+
"url": "https://aws.amazon.com"
8+
},
9+
"scripts": {
10+
"test": "echo 'Not Applicable'",
11+
"test:e2e": "echo 'Not Applicable'",
12+
"build": "echo 'Not Applicable'",
13+
"lint": "echo 'Not Applicable'",
14+
"lint-fix": "echo 'Not Applicable'"
15+
},
16+
"license": "MIT-0",
17+
"repository": {
18+
"type": "git",
19+
"url": "git+https://github.com/awslabs/aws-lambda-powertools-typescript.git"
20+
},
21+
"bugs": {
22+
"url": "https://github.com/awslabs/aws-lambda-powertools-typescript/issues"
23+
},
24+
"homepage": "https://github.com/awslabs/aws-lambda-powertools-typescript#readme",
25+
"devDependencies": {
26+
"@aws-sdk/client-appconfigdata": "^3.245.0",
27+
"@aws-sdk/client-dynamodb": "^3.245.0",
28+
"@aws-sdk/client-secrets-manager": "^3.250.0",
29+
"@aws-sdk/client-ssm": "^3.245.0",
30+
"@aws-sdk/util-dynamodb": "^3.245.0"
31+
}
32+
}

Diff for: mkdocs.yml

+4
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,10 @@ copyright: Copyright © 2023 Amazon Web Services
7979
plugins:
8080
- git-revision-date
8181
- search
82+
- exclude:
83+
glob:
84+
- snippets/node_modules/*
85+
- snippets/package.json
8286

8387
extra_css:
8488
- stylesheets/extra.css

0 commit comments

Comments
 (0)