Skip to content

Commit

Permalink
chore(docs): add docs/snippets to npm workspace (#1251)
Browse files Browse the repository at this point in the history
* chore: add docs/snippets folder to npm workspace

* chore: added mkdocs plugin to exclude node_modules dir from docs

* chore: housekeeping
  • Loading branch information
dreamorosi authored Jan 16, 2023
1 parent 53a1705 commit 439c794
Show file tree
Hide file tree
Showing 6 changed files with 146 additions and 1,210 deletions.
2 changes: 1 addition & 1 deletion docs/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
FROM squidfunk/mkdocs-material
RUN pip install mkdocs-git-revision-date-plugin mkdocs-glightbox
RUN pip install mkdocs-git-revision-date-plugin==0.3.2 mkdocs-exclude==1.0.2
3 changes: 2 additions & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
mike==1.1.2
mkdocs-material==9.0.2
mkdocs-git-revision-date-plugin==0.3.2
mkdocs-git-revision-date-plugin==0.3.2
mkdocs-exclude==1.0.2
32 changes: 32 additions & 0 deletions docs/snippets/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"name": "docs",
"version": "0.0.1",
"description": "A collection code snippets for the AWS Lambda Powertools for TypeScript docs",
"author": {
"name": "Amazon Web Services",
"url": "https://aws.amazon.com"
},
"scripts": {
"test": "echo 'Not Applicable'",
"test:e2e": "echo 'Not Applicable'",
"build": "echo 'Not Applicable'",
"lint": "echo 'Not Applicable'",
"lint-fix": "echo 'Not Applicable'"
},
"license": "MIT-0",
"repository": {
"type": "git",
"url": "git+https://github.com/awslabs/aws-lambda-powertools-typescript.git"
},
"bugs": {
"url": "https://github.com/awslabs/aws-lambda-powertools-typescript/issues"
},
"homepage": "https://github.com/awslabs/aws-lambda-powertools-typescript#readme",
"devDependencies": {
"@aws-sdk/client-appconfigdata": "^3.245.0",
"@aws-sdk/client-dynamodb": "^3.245.0",
"@aws-sdk/client-secrets-manager": "^3.250.0",
"@aws-sdk/client-ssm": "^3.245.0",
"@aws-sdk/util-dynamodb": "^3.245.0"
}
}
4 changes: 4 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,10 @@ copyright: Copyright © 2023 Amazon Web Services
plugins:
- git-revision-date
- search
- exclude:
glob:
- snippets/node_modules/*
- snippets/package.json

extra_css:
- stylesheets/extra.css
Expand Down
Loading

0 comments on commit 439c794

Please sign in to comment.