[edk2-devel] [edk2-wiki][PATCH v3 1/4] Add initial How to Build with Stuart Document

[Rebecca Cran]

According to 
https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections, 
it looks like normal markdown _should_ apply within collapsed sections?


I noticed a few problems with 
https://github.com/tianocore/tianocore.github.io/wiki/How-to-Build-With-Stuart 
:


Example: git clone edk2

Should probably be: git clone https://github.com/tianocore/edk2.git


The Linux instructions for creating a python virtual environment should 
probably be:

python3 -m venv .venv


Though I've been installing the stuart tools into ~/.local/bin which 
allows you to skip the step of using a virtual environment.


Lastly, the Git Submodules step says to use --recursive, which I seem to 
recall other instructions suggesting _not_ to use, since it's not needed.


-- 
Rebecca Cran


On 12/8/22 07:21, Michael Kubacki wrote:
> I write it by hand. HTML comes in because I'm using collapsing content 
> via <summary> sections. Once in those sections, normal markdown 
> formatting does not apply. I've limited HTML usage in those sections 
> to very simple tags that mostly map directly to features allowed in 
> markdown formatting as well (<strong> -> **, <a> -> [](), <code> -> 
> ``, etc.)
>
> Thanks,
> Michael
>
> On 12/7/2022 11:47 PM, Rebecca Cran wrote:
>> What tool do you use to write the pages?
>>
>> It seems to be a mixture of markdown and HTML: for example I'm 
>> surprised to see things like "<strong>C Compiler</strong>" - I'd 
>> expect something like "**C Compiler**" instead.
>>
>
>
> 
>
>


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#97288): https://edk2.groups.io/g/devel/message/97288
Mute This Topic: https://groups.io/mt/95518590/1813853
Group Owner: devel+owner at edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [edk2-devel-archive at redhat.com]
-=-=-=-=-=-=-=-=-=-=-=-