Skip to content

Markbind init --convert improvements #1866

@kaixin-hc

Description

@kaixin-hc

Is there an existing issue for this?

  • I have searched the existing issues

Any related issues?

Other suggestions for MarkBind init command #1782, #1844

Tell us about your environment

MacOS Monterey

MarkBind version

3.1.1

What did you do? Describe the bug

Created a repository with .md files (https://github.com/kaixin-hc/animal-behaviour-LSM1303) and ran markbind init --convert

Steps to reproduce

Clone my repository, navigating to the branch without MarkBind (https://github.com/kaixin-hc/animal-behaviour-LSM1303/tree/toTestInitOn), and run markbind init --convert. Or make your own repository with file names that have spaces.

Expected behavior

Site is created and all elements are natural and intuitive.

Actual behavior

  • Default files(the contents folder) are still created and included in the sitenav by default; since it is a conversion of an existing repo, you would expect these files not to be created and included
  • The sitenav does not work as expected (Files with spaces are not rendered correctly)
  • Instead of the default navigation sidebar name being "Template", it makes more sense for it to be something like "Contents"
  • Titles are not auto-generated for content pages.

Nits

  • Personally, I feel like the default brand image makes it look like there was an error in rendering the favicon, rather than a default placeholder being selected by default.
  • The auto-generated default.md file has a few blank lines after the navbar; I think most linters will flag this as an issue and we can do without them.

Anything else?

No response

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions