search

decentralized-identity / spec-up

Create beautiful, feature-rich technical specifications in markdown
https://identity.foundation/spec-up/
Apache License 2.0
34 stars 28 forks source link

Add an "IETF mode" capability to use a different CSS and layout - and perhaps other SDO formats #37

Open swcurran opened 2 years ago

swcurran commented 2 years ago

It would be great to be able to trigger a different layout from the spec based on an "sdo_format" configuration setting, and perhaps a set of underlying configuration values.

Specific to IETF, there is not a need (IMHO) to use the old fully justified, courier font layout, but things like the header format, the placement of the table of contents and so on to adhere to the IETF style would be nice.

For now, we are using SpecUp in the current style, with a plan to mechanically transform the document if and when an IETF version is needed. The features of SpecUp make it way too useful vs. tools specific to other SDO formats that we've been able to find.

csuwildcat commented 2 years ago

@swcurran I think we can do this almost in pure CSS, and just have the target format var written into an attribute on the document that you can key off of to do CSS mods. If it needs to go further than styles, that could be more tricky.

swcurran commented 2 years ago

I agree. The only fancy things I can see is perhaps to have some config information the header can be formatted to match the "IETF" way and to insert the ToC inline vs. to the side (which we could skip because inline is useless, but hey, they like it that way...).