Packaged to VuePress plugin

boboidream commented 5 years ago

Feature: Packaged to VuePress plugin. It's easier to use the plugin.
Feature: Add pinyinNav to compatible with vuepress-plugin-permalink-pinyin.
Fix issue: https://github.com/ozum/vuepress-bar/issues/5#issue-474089423
Fix bug: When readme.md(not README.md) in folder throw error.
Update readme.
Update test.js.

ozum commented 5 years ago

@boboidream sorry for late answer. Github didn't sent me notifications for this repo.

First of all thanks for this PR. I could not pass all tests. Because lots of time passed since you posted, I did not bother you again, and I implemented some of the details by myself.

Please see latest version.

Implemented

Fixed: regexp with dash (-)
Fixed: missing readme should throw error in all cases. (README.md, readme.md, rEaDmE.md etc.)
Added: pinyinNav

Differently Implemented

Failing tests of this PR are related to sort feature. Your implementation sorts files directly by their name, but it cannot be applied here, because files may be sorted based on order attribute in meta data in markdown file (see line 96 in index.js). So, I added mixDirectoriesAndFilesAlphabetically option which puts directories in alphabetical positions.

Not Implemented yet (Have questions)

If setHomepage option is added, it breaks backward compatibility. Instead of hiding root README, it is possible to delete it. Isn't it?
If we make it vue plugin, how can users add manual configuration? For example:

const getConfig = require("vuepress-bar");
const barConfig = getConfig(`${__dirName}/..`)

module.exports = {
  themeConfig: {
    nav: [{ text: 'External', link: 'https://google.com' }, ...barConfig.nav]
    sidebar: barConfig.sidebar,
  }
};

Question

Regarding #5, where is related changes, so I could fix it too.

Many thanks again.

ozum commented 4 years ago

Due to inactivity for a long time I'm closing this PR. Please feel free to reopen another case.

ozum / vuepress-bar