Aem markdown importer github love in aem

© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.
AEM Markdown Importer: GitHub Love in AEM
Kanika Gera | Technical Product Manager | Adobe Systems

© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. 2
1 | Overview of AEM Markdown Importer
2 | AEM Markdown Importer: Import Process
3 | Using the markdown Importer
4 | Building & Contributing for markdown importer
5 | Q&A

AEM GitHub
Let’s git the party started!

Overview of AEM Markdown Importer

© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2016 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.© 2018 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. 5
Why Use AEM Markdown Importer ?
 Imports Markdown documents into AEM, creating an AEM content package on the go and
make them searchable.
 Content for websites powered on AEM can be easily generated without any authoring. No
AEM Authoring expertise needed to leverage authoring functionalities like scheduled
activation, versioning,
 Easy to edit documents/code for technical writers/developers
 Any markdown file can easily be published on AEM powered websites
 Supports efforts of Open Source documentation

Overview of AEM Markdown Importer
 Standalone markdown importer is a Java application distributed with jar file
 Jar is executed to create AEM content package from markdown files (.md) stored on GitHub
or local file system.
 Generated content package can be deployed using package manager in AEM

AEM Markdown Importer Import Process:

Developer Documentation Import Process:
8

Publishing New/Updating API docs:
9

Using the Markdown Importer

How to Use AEM Markdown Importer
 Prerequisite: Java 8 or higher
 Importer tool can be downloaded from artifactory or can be locally built
 Source code can be checked out from https://github.com/adobe/aem-importer-markdown
which is an Adobe Open Source Project

Running AEM ImporterTool:
Run the tool - content
package generated.
Install the generated
content package in
AEM using the AEM
package manager.
 Configure theYAML
file based on
location of
markdown docs in
GitHub or locally

I. Configure the Importer:
 All configuration happens in a .yaml file.
 Configuration specifies where to find the Markdown files, where the content should be put in AEM
and what kind of content should be created.
 Can be configured to pull content either from corporate GitHub or local filesystem

a) Local Configuration (Import from Filesystem):

b) Corporate GitHub Configuration (Import from GitHub):

II. Run the Importer tool:
 Configure the yml file
 Run the importer with the following command:
 java -jar importer-jar-with-dependencies.jar markdown2AEM.yml

III. Installing the AEM Package:
 After execution of the tool, a package is generated.
 Generated package, can be installed in AEM using the AEM package manager
 Installed package, saves content in repository as jcr node.

Building & Contributing to Markdown Importer:

Building the AEM markdown Importer
 To use the application, check out this source code, then build with Maven:
$ mvn clean package
 If you are using Adobe's default settings.xml and you are outside of Adobe'sVPN, it is a good
idea to disable the default profile:
$ mvn clean package -P !artifactory-corp
 You will end up with a file called target/importer-with-dependencies.jar.

Contributing to the AEM markdown Importer
 Submit a pull request on the repository:
https://github.com/adobe/aem-importer-markdown
 File an issue:
https://github.com/adobe/aem-importer-markdown/issues
 Contribute a release:
https://github.com/adobe/aem-importer-markdown#contributing

Demo

DEMO:

References

References:
 The documentation for the standalone markdown importer tool (which converts Markdown files to
AEM): https://wiki.corp.adobe.com/pages/viewpage.action?spaceKey=AdobeCloudPlatform&title
=Create+content+with+Standalone+Markdown+Importer
 Code base is on https://github.com/adobe/aem-importer-markdown
 The tool can be downloaded from:
https://artifactory.corp.adobe.com/artifactory/webapp/#/artifacts/browse/tree/General/maven-
markdown-tools-release

Questions & Answers

AEM Markdown Importer FAQ’s &Tips:

Kanika Gera
Twitter: @kanboss2002
LinkedIn: https://www.linkedin.com/in/kanikagera/

Aem markdown importer github love in aem

Empfohlen

Empfohlen

Weitere ähnliche Inhalte

Was ist angesagt?

Was ist angesagt? (20)

Ähnlich wie Aem markdown importer github love in aem

Ähnlich wie Aem markdown importer github love in aem (20)

Mehr von Kanika Gera

Mehr von Kanika Gera (7)

Kürzlich hochgeladen

Kürzlich hochgeladen (20)

Aem markdown importer github love in aem