Update documentation - Githubissues

davy7125 / polyphone

A soundfont editor for quickly designing musical instruments.

https://www.polyphone.io

GNU General Public License v3.0

350 stars 46 forks source link

Update documentation #95

Closed lexeii closed 4 years ago

lexeii commented 4 years ago

A few changes that will make both the MD source code and the resulting HTML cleaner and more friendly.

davy7125 commented 4 years ago

The PHP tool I'm using for parsing .md files doesn't support the definition of links (url and images) at the end of the files! I'll merge this work manually, including:

the small changes in the Russian version of "create a soundfont from scratch"
the use of dd / dt
wrappers <div class="doc_warning"> ... </div> and <div class="doc_notes"> ... </div> for the notes and warnings

lexeii commented 4 years ago

OK, thank you.

I used PHP Markdown Extra documentation for reference from here: https://michelf.ca/projects/php-markdown/extra/

(Actually, this page is unavailable for me, so I used Google cached page)

davy7125 commented 4 years ago

Unfortunately I haven't been able to add the "info" or "warning" wrappers. I tried using comments but the library doesn't like them... And if I wrap in html code, we lose the MD formatting inside.

So what I did is:

the small changes in the Russian version of "create a soundfont from scratch"
the use of dd / dt

I close the pull request and I hope the current state of the documentation is OK for you

lexeii commented 4 years ago

Thank you for your work.

I left two comments on your last commit. Please make these small edits as well.