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

Unable to export markdown to folder 'pages' #35

Open
vic-lsh opened this issue Nov 23, 2020 · 2 comments
Open

Unable to export markdown to folder 'pages' #35

vic-lsh opened this issue Nov 23, 2020 · 2 comments
Labels
bug Something isn't working correctly more info needed More information is required

Comments

@vic-lsh
Copy link

vic-lsh commented Nov 23, 2020

context

issue

When I follow the 'getting started' tutorial, I expected a 'pages' folder to be created in my documentation dist folder. But I could not find this folder in the output.

These are the steps I took in my own project. They're the same as what's listed under 'getting started':

  1. created sample markdown file under <project-root>/documentation/sample/sample-page.md
  2. added the following pagesconfig.json
{
  "groups": [
    {
      "title": "Documentation",
      "pages": [
        {
          "title": "My Page",
          "source": "./documentation/sample/sample-page.md"
        }
      ]
    }
  ],
  "theme": "pages-plugin"
}

other steps

I have also tried to generate docs in this repository, to see if a 'pages' folder was generated. Unlike the committed version, I did not see any 'pages' folder either.

These are the commands I ran:

npm install
npm run build:docs                    // presumably this is the right command to generate documentation

Any help on this issue is much appreciated!

@mipatterson
Copy link
Owner

Hey @vic-lee,

Sorry you're having an issue using the plugin. Are there any errors when you execute TypeDoc or are the files just missing?

Off the top of my head, I'm not 100% sure what might be going on. typedoc-plugin-extras doesn't seem like it would cause any issues, based on the plugin description, but typedoc-plugin-monorepo might warrant a little more investigation. Have you tried executing typedoc without either of these plugins?

@mipatterson mipatterson added bug Something isn't working correctly more info needed More information is required labels Nov 23, 2020
@vic-lsh
Copy link
Author

vic-lsh commented Dec 3, 2020

Hi @mipatterson,

Thanks for your suggestion. I removed typedoc-plugin-monorepo and there was no longer an issue. However, this plugin is crucial to my workflow so I can't have it easily removed.

I'm seeing this error when this plugin is running with typedoc-plugin-monorepo:

model.kindOf is not a function

I'm not sure if the error source is from this plugin or from typedoc-plugin-monorepo. Do you have any idea about where this error is coming from?

Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working correctly more info needed More information is required
Projects
None yet
Development

No branches or pull requests

2 participants