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

Add documentation on indentation support for components #1719

Merged
merged 3 commits into from
Jan 21, 2022

Conversation

tlylt
Copy link
Contributor

@tlylt tlylt commented Jan 15, 2022

What is the purpose of this pull request?

  • Documentation update
  • Bug fix
  • Feature addition or enhancement
  • Code maintenance
  • Others, please explain:

Overview of changes:
Fixes #1015

As mentioned in the above issue, indenting components might be a common use case. Let's include a section in the tips and tricks to inform users on how to use bootstrap classes to indent components.

Changes include:

  • enable pageNav on the tips and tricks page for easier navigation
  • add in "indent component section"
  • include the above section under "using components/presentation" for more visibility
  • a minor update on the formatting content page to make "tips and tricks" visible in pageNav

Anything you'd like to highlight / discuss:
I see that there are "add-class" for adding classes. I used "class" directly as it is shorter.

Testing instructions:
See preview:

Proposed commit message: (wrap lines at 72 characters)
Add documentation on indentation support for components

Users may need to indent components to align with nearby
content.

Let's add in a section in 'tips and tricks' to show examples
of how to indent components with bootstrap utility classes.


Checklist: ☑️

  • Updated the documentation for feature additions and enhancements
  • Added tests for bug fixes or features
  • Linked all related issues
  • No unrelated changes
    • a minor update on the "formatting content" page to make "tip and tricks" visible in pageNav

@tlylt tlylt marked this pull request as ready for review January 19, 2022 05:55
@tlylt tlylt changed the title [WIP] Add documentation on indentation support for components Add documentation on indentation support for components Jan 19, 2022
Copy link
Contributor

@jonahtanjz jonahtanjz left a comment

Choose a reason for hiding this comment

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

Thanks @tlylt! Looks clear and detailed.

I see that there are "add-class" for adding classes. I used "class" directly as it is shorter.

Yup using "class" on components should work as well.

LGTM 👍

@jonahtanjz jonahtanjz added this to the 4.0 milestone Jan 20, 2022
@jonahtanjz jonahtanjz merged commit 55ae7e1 into MarkBind:master Jan 21, 2022
@jonahtanjz jonahtanjz modified the milestones: 4.0, 3.1.1 Jan 22, 2022
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.

Add indentation support for components
2 participants