-
-
Notifications
You must be signed in to change notification settings - Fork 211
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix #148 single source of truth for the changelog #160
Conversation
-w $MOUNT_FOLDER \ | ||
-p $MKDOCS_DEV_PORT:$MKDOCS_DEV_PORT \ | ||
-e MKDOCS_DEV_ADDR="$MKDOCS_DEV_ADDR:$MKDOCS_DEV_PORT" \ | ||
squidfunk/mkdocs-material:3.2.0 $* |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just making sure, $*
is intended yes?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes sure it is :-)
|
||
It will run mkdocs in a [docker](https://www.docker.com/) container. | ||
|
||
Running the script without any params the `serve` command. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This sentence doesn't quite make sense to me grammatically 🤔
|
||
Running the script without any params the `serve` command. | ||
The server is exposed on localhost on port 8000. | ||
If you want to configure port serve is exposed on you can use the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here I'm also not sure.. should it be "if you want to configure a port where the server is exposed on?
awesome work! thank you very much! :) |
I will look at the grammar issues, did that while speaking to my wife, I may have missed some stuff 😄 |
Fix jazzband#148 single source of truth for the changelog
This fixes #148 by making
CHANGELOG.md
the only source of truth for the doc.It is achieved by symlinking it in the
docs
folder.I added a docker utility to work on the doc + documentation in the README on how to build the doc (doc for doc 🙄)
Also fixed an easy deprecation warning in mkdocs.