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

Styling and minor fixes #23

Closed
Evgenus opened this issue Aug 11, 2014 · 7 comments
Closed

Styling and minor fixes #23

Evgenus opened this issue Aug 11, 2014 · 7 comments
Labels
bug Functionality does not match expectation

Comments

@Evgenus
Copy link

Evgenus commented Aug 11, 2014

I've managed to make typedoc work for me and it is awesome. I've found some minor defects

  1. No first letter in path.
  2. In narrow screen resolution (like on phone) TOC should be hidden. Maybe some css framework like bootstrap or zurb-foundation could be helpful.
  3. float: right seems to be not a good idea. It is better just without it.
@sebastian-lenz
Copy link
Member

Hi Evgenus, nice to hear that you managed to get TypeDoc to work.

Your issue 1 seems to be related to a bug in the current version, see issue #21. I hope the incorrectly trimmed path is resolved with the next version.

Issue 2 and 3 are template related. I had some discussions with my colleagues about the current template lately and they will be updated with the next version, I'll take your points into account.

@Evgenus
Copy link
Author

Evgenus commented Aug 24, 2014

It looks like 3 was fixed in 0.1.1

@sebastian-lenz
Copy link
Member

The new version contains a revamped theme, I did with the comments just as you said. On smaller screens the navigation first reduces its margins and then disappears so 2 should be resolved as well?

No luck with 1? The paths are still incorrectly truncated for you?

@Evgenus
Copy link
Author

Evgenus commented Aug 25, 2014

2 There still is the case when navigation bar don't stick to the screen because it is too long, however there is enough space for content. In that case I could suggest to show only part of navigation panel and scroll it so the closest navigation point will be at the middle of the screen. See example below (this page is really long. Navigation panel more than 3 screens tall). Same behavior you can find in Visual Studio or Sublime "minimap scrollbar".

typedoc

Yeah. No luck with 1 yet.

@sebastian-lenz
Copy link
Member

The current behaviour for the navigation is as follow:

  • If the entire navigation fits into the screen height it will become sticky as soon as it reaches the window top.
  • Else if the current page's navigation (the part with the gray border on the left) fits into the screen height it will become sticky as soon as it reaches the window top.
  • Else no sticky behaviour is applied.

The bad thing is that you cannot manually scroll the navigation. As it sits on the right we would end up with two scrollbars on the right - one for the content and one for the navigation. Your solution sounds interesting but I guess it won't work on mobile devices (e.g. iPad). But I'll give it a try when I'm back at my computer.

1 is bugging me. Could you help me resolving this bug by providing me with some infos of your exact environment (same as #21):

Can you provide any hint as of where the problem occurs? Does the project span across multiple hard drives, are there any special characters in your directory names or something similar?

When you launch TypeDoc with --verbose it should print several lines starting with "Processing" or "Skipping":

Running TypeScript compiler
Processing D:/node_modules/typescript/bin/lib.d.ts
Skipping declaration file D:/node_modules/typescript/bin/lib.d.ts
Processing D:/examples/basic/src/classes.ts
Processing D:/examples/basic/src/enumerations.ts
Processing D:/examples/basic/src/flattened.ts
Processing D:/examples/basic/src/functions.ts
Processing D:/examples/basic/src/modules.ts
Processing D:/examples/basic/src/single-export.ts
Resolving project
...

Do you see anything unusual there?

@Evgenus
Copy link
Author

Evgenus commented Aug 26, 2014

Can you provide any hint as of where the problem occurs? Does the project span across multiple hard drives, are there any special characters in your directory names or something similar?

Sure. You can try it yourself https://github.com/Evgenus/bigint-typescript-definitions

> typedoc --out ./docs ./bigint/bigint.d.ts --includeDeclarations --name "BigInt Typescript Definitions" --verbose

Using TypeScript 1.0.1 from c:\Users\Eugene\AppData\Roaming\npm\node_modules\typedoc\node_modules\typescript\bin
Running TypeScript compiler
Processing c:/Users/Eugene/AppData/Roaming/npm/node_modules/typedoc/node_modules/typescript/bin/lib.d.ts
Skipping declaration file c:/Users/Eugene/AppData/Roaming/npm/node_modules/typedoc/node_modules/typescript/bin/lib.d.ts
Processing O:/bigint-typescript-definitions/bigint/bigint.d.ts
Resolving project
Starting renderer
Warning: Could not empty the output directory.
Render globals.html
Render index.html
Render modules\bigint.html
Render interfaces\bigint.bigint.html
Render interfaces\bigint.irandom.html
Documentation generated at O:\bigint-typescript-definitions\docs

@sebastian-lenz
Copy link
Member

Okay, the problem seems to arrise due the different drive letters. I've checked in a bugfix that should resolve this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation
Projects
None yet
Development

No branches or pull requests

2 participants