diff --git a/.prettierignore b/.prettierignore index abf91db..42061c0 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1 +1 @@ -README.md1 \ No newline at end of file +README.md \ No newline at end of file diff --git a/.prettierrc.yaml b/.prettierrc.yaml index b7399c1..ab043b3 100644 --- a/.prettierrc.yaml +++ b/.prettierrc.yaml @@ -1,6 +1,6 @@ trailingComma: 'es5' tabWidth: 2 -semi: false +semi: true # ^^ This is for semicolon. singleQuote: true # ^^ This rule doesn't specify for jsx. diff --git a/README.md b/README.md index 5ccf70c..95d9b00 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ # Test MARKDOWN AUTO DOCS 1 -Note: I have disabled this file's formatting with prettier in `.prettierignore` file. +### Notes on usage of autodocs in this repository + +- *Note: I have disabled this file's formatting with prettier in `.prettierignore` file because prettier adds empty lines before and after the code snippets which are then removed by `autodocs-github-actions` when its run on server. Thus I'm removing prettier for this file. (Future: If I ever want to use prettier --- then the way is to run autodocs on your own in the workflow file and then re-run the prettier before commiting the code so any empty line side-effects made by autodocs are removed even before they are commited to the git.* + +- Some other issues I was facing earlier are mentioend here - https://github.com/dineshsonachalam/markdown-autodocs/issues/33