Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Spike sassdocs integration #1

Closed
wants to merge 10 commits into from
Closed

Spike sassdocs integration #1

wants to merge 10 commits into from

Conversation

NickColley
Copy link
Contributor

There's a fair bit of complexity in the render view logic which would be nice to simplify but this is hopefully a good proof of concept for us to talk about.

<% end %>

<% if doc.example %>
#### Example
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't like how the markdown needs to be indented differently to the rest of the file for it to render properly, makes it hard to read...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@m-green
Copy link
Contributor

m-green commented Feb 12, 2020

So good to see this in the TDT! Awesome work Nick.
Quick question - is is possible to remove the <hr> at the end of each subsection?

@NickColley
Copy link
Contributor Author

@m-green done

@NickColley
Copy link
Contributor Author

Source code links should be permalinked to the specific version being deployed

@NickColley
Copy link
Contributor Author

NickColley commented Feb 21, 2020

If we updated tech docs gem to allow disable_indented_code_blocks: true we could indent the file and have it read out easily.

https://github.com/alphagov/tech-docs-gem/blob/master/lib/govuk_tech_docs.rb#L43-L51

Edit: even if this is enabled markdown will not render, so i guess we should avoid this.

@NickColley
Copy link
Contributor Author

NickColley commented Feb 21, 2020

Added a change to handle deprecation warnings:

Probably should have a 'deprecated:' prefix or something.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants