search

php / web-doc

http://doc.php.net
33 stars 84 forks source link

revise wording for building docs tutorial #17

Closed tiffany-taylor closed 3 years ago

tiffany-taylor commented 3 years ago

This improves upon https://github.com/php/web-doc/pull/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.

tiffany-taylor commented 3 years ago

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.

salathe commented 3 years ago

change text reference "Set up local php.net mirror" into a link that works with markdown and safely converts into HTML for doc.php.net. Currently [Set up a local php.net mirror](/#set-up-a-local-phpnet-mirror) does not appear to correctly convert into HTML.

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:

<a id="set-up-a-local-phpnet-mirror"></a>
## Set up a local php.net mirror
This is explained in the [Set up a local php.net mirror](#set-up-a-local-phpnet-mirror) section.