Skip to content

Improves code styles #133

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

Merged
merged 9 commits into from
Feb 28, 2022
Merged

Improves code styles #133

merged 9 commits into from
Feb 28, 2022

Conversation

HaSistrunk
Copy link
Member

@HaSistrunk HaSistrunk commented Feb 22, 2022

Fixes #129

Updates styles for both inline code and code blocks. Styles are compatible with Rouge, the Jekyll built-in support for syntax highlighting of many languages.

Check out http://docs.dev.rockarch.org/argo/use-api/ for examples of what these styles look like in the documentation.

@HaSistrunk HaSistrunk requested a review from daremiyo February 22, 2022 19:41
Copy link
Contributor

@daremiyo daremiyo left a comment

Choose a reason for hiding this comment

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

I think the improvements to the inline code and block code styles look great! the styles help distinguish that this is code, and with the code blocks, it prevents the need for mixing the example styling with the code styling which was utilized as a solution in some of our docs and was messy

@HaSistrunk
Copy link
Member Author

HaSistrunk commented Feb 24, 2022

it prevents the need for mixing the example styling with the code styling which was utilized as a solution in some of our docs and was messy

Good point - we should update the Docs Guide to note the different uses and update those docs for consistency. I can double check, but do you remember where we used the docs-example class where we can just use code blocks now?

@daremiyo
Copy link
Contributor

it prevents the need for mixing the example styling with the code styling which was utilized as a solution in some of our docs and was messy

Good point - we should update the Docs Guide to note the different uses and update those docs for consistency. I can double check, but do you remember where we used the docs-example class where we can just use code blocks now?

that's a good idea! there are examples of that in the Digital Media Transfer Workflow doc and the Guide to Using Archivematica

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.

Improve styles for code snippets
2 participants