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

Unmix presentation and content for docpages #3786

Merged
merged 6 commits into from
Jan 15, 2025
Merged

Unmix presentation and content for docpages #3786

merged 6 commits into from
Jan 15, 2025

Conversation

koopmant
Copy link
Contributor

@koopmant koopmant commented Jan 15, 2025

This adds css for docpages, to enable writing simple markdown focused on content rather then presentation.

For example this removes the need to write
<h3 class="text-center">heading text</h3>
to create a centered heading at the top of the page.
This can now be written simply as
### heading text

@koopmant koopmant self-assigned this Jan 15, 2025
@koopmant koopmant requested a review from jmsmkn as a code owner January 15, 2025 09:56
@koopmant
Copy link
Contributor Author

Images are still an issue. From the markdown syntax page:

As of this writing, Markdown has no syntax for specifying the dimensions of an image; if this is important to you, you can simply use regular HTML tags.

We could probably use extensions to tackle images without having to write HTML, but I don't think it's worth the effort.

Copy link
Member

@jmsmkn jmsmkn left a comment

Choose a reason for hiding this comment

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

Looks good! Small question and in the new script there are some images that are being used from the production instance. Could you instead create some images on the local instance and use those? They do not have to be the same ones, we have some other jpg/png images in the codebase.

We could probably use extensions to tackle images without having to write HTML, but I don't think it's worth the effort.

Agreed! I think what we do with the class attributes is also good enough.

app/grandchallenge/core/static/css/base.scss Outdated Show resolved Hide resolved
@koopmant
Copy link
Contributor Author

Could you instead create some images on the local instance and use those? They do not have to be the same ones, we have some other jpg/png images in the codebase.

Will do!

@koopmant koopmant requested a review from jmsmkn January 15, 2025 12:11
@jmsmkn jmsmkn merged commit 9c88943 into main Jan 15, 2025
8 checks passed
@jmsmkn jmsmkn deleted the docpage-css branch January 15, 2025 12:31
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.

2 participants