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
revise wording for building docs tutorial #17
revise wording for building docs tutorial #17
Conversation
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.
Only some minor details that tripped me up because of a dockerized setup.
my PHP "binary" looks like this:
#!/bin/bash
docker run -it --rm -v $(pwd):/repo -w /repo mileschou/xdebug:8.0 php $@
As that only mounts the current working directory that is a bit like a chroot environment that needs some tweaks for paths 😉
I'm noting a comment I placed in the markdown in here, and will remove the comment from markdown. I would like to complete this as a future TODO item, but I'm thinking it will require minor refactoring of the Parsedown script.
|
We should be able to get away with adding an anchor tag with an id, and then linking to that with the id. Parsedown (and really, any Markdown renderer) should be fine with that. For example:
|
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.
Thanks Tiffany!
I have added a few comments, but they're all minor. I'd be happy to see this PR merged as-is and any (or none) of my comments addressed later.
This improves upon #15 which uses the directory structure from doc-base's readme. I've also revised some assumptions and notes.
I was not able to fully test the symlink section, but I believe it's correct.