You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/manual.md
+31Lines changed: 31 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -387,6 +387,37 @@ target is enabled, `somesy` will generate your `codemeta.json` by:
387
387
As `codemeta.json` is considered a technical "backend-format" derived from other
388
388
inputs, in most cases you probably do not need or should edit it by hand anyway.
389
389
390
+
## Using somesy to insert metadata into project documentation
391
+
392
+
While `somesy` can synchronize structured metadata files and formats, there is a common case that cannot be covered by the `sync` command - when project metadata should appear in plain text documents, such as documentation files and web pages.
393
+
394
+
As for documentation the needs and used tooling in different projects is vastly different, `somesy` provides a very general solution to this problem
file in the somesy repository, which is also shown as the
402
+
[Credits](./credits.md) page, using the following command:
403
+
404
+
```shell
405
+
somesy fill docs/_template_authors.md -o AUTHORS.md
406
+
```
407
+
408
+
??? example "_template_authors.md"
409
+
```
410
+
--8<-- "docs/_template_authors.md"
411
+
```
412
+
413
+
??? example "AUTHORS.md"
414
+
```
415
+
--8<-- "AUTHORS.md"
416
+
```
417
+
418
+
The template gets the complete
419
+
[ProjectMetadata](reference/somesy/core/models.md#somesy.core.models.ProjectMetadata) as its context, so it is possible to access all included project and contributor information.
420
+
390
421
## FAQ
391
422
392
423
### Somesy introduces it's own metadata format... isn't this counter-productive?
0 commit comments