search

adobe-dmeservices / custom-metadata

The home for a Custom Metadata Panel extension for Creative Cloud
https://exchange.adobe.com/creativecloud.details.103752.html
17 stars 8 forks source link

Github pages site for user manual #4

Closed adorton-adobe closed 3 years ago

adorton-adobe commented 3 years ago

I've migrated the user manual to a Jekyll project so we can publish with Github pages.

See what it looks like here: https://adorton-adobe.github.io/custom-metadata/en/

I needed to make some Markdown formatting changes to accommodate Jekyll's kramdown processor.

NOTE: once this is merged, we will need to enable the GH Pages build in the repo settings.

adorton-adobe commented 3 years ago

Actually - I think I need to enable the Pages build before we merge the PR. Once the review is approved I will update the build setting and add a note that it is ready to merge.

jameslockman commented 3 years ago

Is there a way to have the table of contents float on the left hand side? I want to make this more like a collection of pages, as some will change with version updates and others will not.

James

James Lockman | Senior Manager, Digital Media Services | Adobe | T +1 917 934 0849 | C +1 917 284 2268| jlockman@adobe.com

From: Andrew Dorton notifications@github.com Reply-To: adobe-dmeservices/custom-metadata reply@reply.github.com Date: Thursday, October 1, 2020 at 7:35 PM To: adobe-dmeservices/custom-metadata custom-metadata@noreply.github.com Cc: James Lockman jlockman@adobe.com, Review requested review_requested@noreply.github.com Subject: Re: [adobe-dmeservices/custom-metadata] Github pages site for user manual (#4)

Actually - I think I need to enable the Pages build before we merge the PR. Once the review is approved I will update the build setting and add a note that it is ready to merge.

— You are receiving this because your review was requested. Reply to this email directly, view it on GitHubhttps://nam04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fadobe-dmeservices%2Fcustom-metadata%2Fpull%2F4%23issuecomment-702450357&data=02%7C01%7Cjlockman%40adobe.com%7Ca9179b63298140ed1add08d86662bd53%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C637371921573706408&sdata=hpBJuMPhKG5Znge7Osw0rb8SFUscHtvMp0IVAjzuc0Q%3D&reserved=0, or unsubscribehttps://nam04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAAUJHGJO2MT7IYLEKVIBMK3SIUG5RANCNFSM4SBAHMKQ&data=02%7C01%7Cjlockman%40adobe.com%7Ca9179b63298140ed1add08d86662bd53%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C637371921573716408&sdata=OEvMa0vD7Q%2Bq5K%2FELFcEEVsjguij4%2FhMaIteE7%2Bv%2BDc%3D&reserved=0.

adorton-adobe commented 3 years ago

The TOC links to content on the current page. When we expand the documentation (or split up what we have) to include multiple pages, we can create a left-hand navigation sidebar. I'm not even sure the page-level TOC can be formatted in that way - it is generated from the page markdown content, not from the HTML page template.