Comments (5)
relative to your shared folder, then you'll need to use such paths for everything else, I could make an option for the builder to configure root path for file resolver if it will help you
Hi @skoropadas, np. I managed it. So I created an angular workspace where I have all the libs and projects co-exist. I am referencing using a relative path to the common macro file in one of the libs. Not sure whether this is optimal approach, but it helps me to keep the code clean, tidy and organised.
from ng-doc.
Yeah, it seems that nunjucks does not support the feature you're looking for. To implement the documentation in this way, I would recommend using an NX monorepo with multiple apps dedicated to documentation. This approach will allow you to have access to the source code and easily share some things between different documentation apps.
I also think that this is a good practice as it enables you to release the documentation and new library versions together. Additionally, it allows you to identify any errors that may arise during the compilation of the documentation app.
from ng-doc.
NX monorepo
NX monorepo is similar to Angular workspace. The problem with this is still the same, I need to refer the macros with hardcoded paths like ../../../../ and I cannot configure paths based on a configuration the way we define paths in the compiler option in tsconfig.app :(
from ng-doc.
NX monorepo
NX monorepo is similar to Angular workspace. The problem with this is still the same, I need to refer the macros with hardcoded paths like ../../../../ and I cannot configure paths based on a configuration the way we define paths in the compiler option in tsconfig.app :(
Well there is no workaround for that, because nunjucks uses one file resolver for everything, so if you e.g. start having paths relative to your shared folder, then you'll need to use such paths for everything else, I could make an option for the builder to configure root path for file resolver if it will help you
from ng-doc.
@skoropadas I have ng project with one library only meant to be published as package.
Currently it's described with storybook.
Tried to install ng-doc, but it partially failed due to absence of app.module.
Will ng-doc project support just libraries in foreseeable future?
from ng-doc.
Related Issues (20)
- Support for native i18n / $localize + localized markdown HOT 3
- [Feature] Demo Pane viewport and theme support
- [Feature] Custom Tabs in Demo HOT 5
- [Feature] Display Component Properties in Component Tabs and on Page HOT 1
- [Bug] Configure Home icon route path of breadcrumb
- Add plugin for customizing the transformation of markdown to HTML
- [Query] Usage of Snippets
- [Bug] Support angular17html in code fences HOT 2
- [Feature] Support inline template syntax highlighting HOT 2
- [Query] Usage of Recreate option in the Playground HOT 2
- [Bug] API Link Reference missing for optional properties of a component HOT 2
- [Feature] Customising Playground HOT 2
- [Feature] Add possibility to provide custom properties for custom sidebar HOT 4
- [Query] What is ```twig fence code and what all the markdown fence code supported in Ng Docs? HOT 3
- [Feature] Add tabs for common macros and Angular components to display their usage variations along with previews
- Demo/Demo Pane Crash with "Unexpected end of JSON input" [Bug] HOT 4
- [Bug] Build / serve crash when using Angular 18.1 HOT 9
- [Bug] Anchor seems not working with french accents HOT 3
- [Bug] "Octal escape sequences are not allowed" validation error using generated demo-assets code HOT 1
- [Bug] 17.6.15 Build failed HOT 6
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from ng-doc.