How do you build the Docs? #2121
-
|
I'd like to build the documentation and i dont see any obvious ways of doing that in the package.json scripts section. I can build everything and run it, but when i select the docs link or prepend /docs to the url it doesnt redirect appropriately and i cant find the docs. I think it would be super useful for a company that might leverage tabler for some internal tooling to be able to host their own branded documentation page. Specifically with the code snippets and whatnot to show the devs how and when to use a specific component or layout. |
Beta Was this translation helpful? Give feedback.
Replies: 2 comments
-
|
@janstadt - If you're still wondering about this - sorry, a little behind in answering this one. Ever since I started contributing to Tabler a little while ago, I wondered the same thing. Recently-ish, codecalm added the documentation as its own app into the source code, but I still couldn't figure out how to access it. |
Beta Was this translation helpful? Give feedback.
-
|
Thanks @ethancrawford. Im able to successfully build this all locally. We are in the process of overriding some of the color palettes with our company colors and another question came up around this. Is it possible for you to provide me with some of your github actions that you use to build and deploy the tabler.io code to github pages? We'd really like to use the repo and the docs section with our own implementations of the componentry (we use ng-bootstrap and would like to provide examples of those components for our dev team). I could just deploy the app to a host locally, but would like to learn more about how we could leverage gh pages and actions to do this all within gh. We are also in an enterprise so i unfortnuately cant just fork the repo so i plan on using the repo as a base and push it to our private enterprise repository in gh. If possible, i can be reached via email as well or some other way of figuring this out. |
Beta Was this translation helpful? Give feedback.
@janstadt - If you're still wondering about this - sorry, a little behind in answering this one. Ever since I started contributing to Tabler a little while ago, I wondered the same thing. Recently-ish, codecalm added the documentation as its own app into the source code, but I still couldn't figure out how to access it.
Just last week, I finally figured it out after spending a while hunting through the source code: the documentation app is built as part of the overall build process, but to access it you then visit
http://localhost:3010🙂(I added a note to the readme to make this more visible: #2317).