Skip to content

Commit

Permalink
Update.
Browse files Browse the repository at this point in the history
  • Loading branch information
sahilrajput03 committed Dec 18, 2024
1 parent 27bc9ed commit 4ea54dd
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
@@ -1 +1 @@
README.md1
README.md
2 changes: 1 addition & 1 deletion .prettierrc.yaml
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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

<!-- MARKDOWN-AUTO-DOCS:START (CODE:src=./myfile.js) -->
<!-- The below code snippet is automatically added from ./myfile.js -->
Expand Down

0 comments on commit 4ea54dd

Please sign in to comment.