Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Repo info
Activity
    Mahdi Javaheri
    @javaherisaber

    @cjbrooks12
    I'm having this error in admin:

    Error loading the CMS configuration
Config Errors:
'collections[0].files[0].fields[2].types[2].fields' fields names must be unique
'collections[0].files[0].fields[2].types[6].fields[3].fields' should NOT have fewer than 1 items
...

Check your config.yml file.

    my orchid version is : 0.16.10

    Radimir Sorokin
    @qradimir
    @cjbrooks12 Great, thank you for fixing the issue with missing links! I've also noticed that there is a problem with duplicated "interface" word in the doc of java interfaces. At least using Editorial theme.
    Seth
    @SethiPandi

    Good morning! Just wanted to ask since I'm unsure based on the docs.

    I'm currently developing a command handling framework, and working on making a small documentation generator, hopefully with results comparble to Spring REST Docs.

    Is Orchid a suitable solution for this, if I wanted to export all commands as files with Asciidoctor, and then have Orchid generate the static website?

    Seth
    @SethiPandi
    ^ Disregard this, I was having a lot of trouble with the documentation before, but this is appropriate for my use case. Just had to dig through the examples/tutorials as well to figure out how to use it.
    Chaitanya Chunduri
    @cchunduri
    Hi Everyone, I'm getting this issue, this is my first run with orchid, could you please help me? orchidhq/Orchid#382
    Andre_601
    @Andre601
    Hey. I was interested in using this software to build some documentation for my Java project. But I don't have really the knowledge of what I need to look at (e.g. if there are any files I have to create first or if I have to download something first) to make this work for me, so a bit of assistance would be greatly appeciated.
    Basically, do I want to generate Javadocs (and also some markdown wiki pages) using Orchid. My project is made in java (not kotlin) and I'm currently in the process of splitting it up into several modules.
    Casey Brooks
    @cjbrooks12
    @javaherisaber That looks like an error with the NetlifyCMS, I'll have to look into what's going on there. If you aren't using that, you can remove the plugin and it will be fine. Also, You're on an older version of Orchid, so you might see if the issue is still there on newer versions
    @Andre601 Orchid is run as a Gradle or a Maven plugin, and it works with Java in the exact same way that it does with Kotlin. The code documentation tutorial walks you through getting it set up for Kotlin, but you can pretty much just replace "kotlin" with " java" throughout that tutorial and have it work for you. You can also look at the java-site tutorial repo to see how it's set up with Gradle, which should follow the linked tutorial as well
    Andre_601
    @Andre601
    I checked both pages, but still run into the issue I described in my issue posted here: orchidhq/Orchid#384
    Casey Brooks
    @cjbrooks12
    I'll continue the conversation there
    Andre_601
    @Andre601
    Basically, Orchid somehow ignores the config file completely and just builds the default pages used by the java-site example you just linked.
    Casey Brooks
    @cjbrooks12
    From the linked issue, I think you just have the config.yml file in the wrong location. It needs to be in src/orchid/resources, not src/main/resources
    Sean M
    @stmty9
    [Javadoc related]
    I was looking over the examples, and read through a few issues and RFEs - I could not find whether or not it was supported to generate javadoc from a dependency rather than having the source code in the documentation project. We have documentation spread across multiple projects and multiple modules within those projects
    Sean M
    @stmty9
    Is there any way to configure page options for specific taxonomies like you can with pages in config.yml?
    Sudhir Khanger
    @sudhirkhanger
    What are the things I should be familiar with if I want to theme Orchid for a personal blog? Any specific language I should be familiar with? I am an android developer so my web skills are non-existent.
    Sudhir Khanger
    @sudhirkhanger
    There were a two errors/warning when I built from Git https://gist.github.com/sudhirkhanger/1a0d0911399c2d62c788962f2704a84e
    Casey Brooks
    @cjbrooks12
    @stmty9 You can configure the archive pages (the ones listing links to the gathered pages), but you can't configure the individual pages that are gathered into a taxonomy. There's a circular dependency there: the pages need to be built and configured before they can be gathered into taxonomies, so the taxonomies can't also go configure the pages. You're better-off using the pages plugin to set up and configure the pages you want, and then using the collection archives to make the archive pages based on those page groups.
    @sudhirkhanger Custom themes in Orchid are basically just Pebble templates over normal HTML. You'd need to be familiar with HTML and CSS (and optionally JS for more interactive elements) to make a custom theme. It's also helpful to be pretty familiar with Orchid itself using an existing theme: trying to create a theme without first understanding how Orchid does things and it's specific additions to Pebble templates will be difficult, the theming system just isn't at a point yet to really be easily done without some more advanced knowledge of Orchid
    Casey Brooks
    @cjbrooks12
    As for the errors on the quickstart repo, it's been orchidhq/OrchidStarter#9, I just haven't had time to fix it yet. But if you try using the Editorial theme it should work for you
    Sean M
    @stmty9
    I was really just looking for a smarter way to customize the menus for the different taxonomies, for both archive and term.
    Ola Gawell
    @ola-jayway
    Hi! Is there any way to include content of another file (source code) into a static (wiki) page? We some code examples on our static pages. We would like to put the example code in real source files to benefit from refactoring abilities in the IDE. So if it's possible it would be great if you could use some include tag (from pebble) to include contents of other files. Does anyone know how to do this?
    Sean M
    @stmty9
    you can write your own generator to do that. I am currently working on a generator to pull files from other places in our code to put pages together.
    Casey Brooks
    @cjbrooks12
    @ola-jayway The Snippets plugin is what you're looking for. With it, you'll be able to add comment regions into your source or unit test files, and Orchid will scan those files and make it easy to embed what it finds
    Bryce McGaw
    @bryce3325
    Hi! I'm working on adding orchid to our project, and followed the setup guide exactly. I had it working months in the past but I believe something has changed in our app that's now causing it not to work. I'm getting the error "The 'java' plugin has been applied, but it is not compatible with the Android plugins."
    I've researched everything I could find but haven't had any luck on fixing it so far. Any idea of what could be going wrong?
    Casey Brooks
    @cjbrooks12
    Orchid can't be used in the same Gradle subproject as an Android project (one that has apply plugin: "com.android.library" or apply plugin: "com.android.application" in it). This has always been the case as the Android Gradle plugins do not use the Java plugin toolchain. For Android projects, you'll have to move it to another subproject like :docs and update the paths to the java/kotlin sources to the main project directory, which is the best practice anyway. You can see an example of this in all the repos I maintain and use Orchid in, such as copper-leaf/clog or orchidhq/Orchid itself.
    Ola Gawell
    @ola-jayway
    @cjbrooks12 Thank you! That was exactly what I was looking for :)
    whiteancient
    @whiteancient

    I have added the following rows to a typescript file:
    // snippet::snippet-init-createviewer
    createMethod() {
    console.log("I create something");
    }
    // end::snippet-init-createviewer

    And I have added the following config to config.yml:
    snippets:
    sections:

        - tags: ['embedded_snippets']
      adapter:
          type: 'embedded'
          baseDirs: ['./../../../../minimal-viable-product/src']
          recursive: true

    But I can not get anything to be seen in the list in /admin/snippets.
    I have tried both absolute and every possible combination of relative paths for baseDirs.
    Is there something else I need to do as well to catch my little code-snippet?
    The docs and the code is in two different modules.

    Casey Brooks
    @cjbrooks12
    I'm guessing the path isn't quite right. The baseDirs path should be relative to the config.yml file. You can test you have the right path by cd-ing to the directory with your config.yml file, and do ls ./../../../../minimal-viable-product/src and see if it lists the files/folder you're expecting (and adjusting the relative pathing if necessary until it does)
    Abinash
    @abinash18
    Hey guys i have been stuck on the setup for orchid the websiite just dose not seem to build it says it has generated pages but when i go to localhost:8080 when serving the page is empty
    whiteancient
    @whiteancient
    A little late, but thank you @cjbrooks12 for your response. Yes, it was of course my own fault, but not in the slashes, but that i wrote "minimal" instead of "minimum"....
    prepconcede
    @prepconcede
    Hello, is there a way to make orchid support unicode(i guess thats the problem, bc russian symbols in KDoc are rendered as �)
    Hypertrophy
    @Hypertrophy
    I also have the problem with encoding. In the front matter I can use a german umlaut in the blog post title and it displays correctly. In the blog text (markdown) it does not work and a question mark is displayed.
    Hypertrophy
    @Hypertrophy
    @prepconcede Okay, I have found a solution for this. You have to specify the encoding because it is platform dependent. Add this to your build.gradle:
    orchidServe {
  systemProperty "file.encoding", "UTF-8"
}
    Alfhir
    @Alfhir
    Hello together!
    I like Orchid very much and i´d like to pitch it as the ssg for documentation at my workplace. I have a question: Is it somehow possible to source data from multiple repositories?
    Thank you very much. Regards
    prepconcede
    @prepconcede
    @Hypertrophy thank you so much!!
    Paul Franz
    @FranzGames
    Question: I have a bunch of files in the directory assets/newsletters. How do I iterate over them so that I can dynamically list them on a page? I have tried "for letter in find(collectionType='asset',collectionId='assets/newsletters/')" , "for letter in findAll(collectionType='asset',collectionId='assets/newsletters/')" and "for letter in assets". None of them seems to work. Note: I am on 0.21.0 of Orchid.
    Harald Pehl
    @hpehl

    Hi there,

    I'd like to use orchid to document my Kotlin/JS library. When I try to add the orchid plugin to my gradle build file I get errors.

    I think this drills down to https://github.com/orchidhq/Orchid/blob/dev/buildSrc/orchidPlugin/src/main/groovy/com/eden/orchid/gradle/OrchidPlugin.groovy#L13 which expects a Java project. Since I'm using Kotlin/JS this won't work.

    Do you see any chance to relax this restriction or have an idea how to use orchid w/ a Kotlin/JS lib?

    loke
    @loke:dhsdevelopments.com
    [m]
    Hello, is there a roadmap for this project? My project is Kotlin multiplatform, and I included an Orchid subproject which worked fine. However, I have some issues caused by what seems to be limitations and I was wondering if there is any chance these will be fixed in the future.
    First and foremost, my documentation is in asciidoc, and the documentation says I cannot include images in asciidoc documents. Another issue is that my documentation uses :experimental features (specifically kbd:[foo] which doesn't seem to be picked up by asciidoc when run by Orchid).
    Yet another issue is that when I build, I get this error message:
    Deprecated Gradle features were used in this build, making it incompatible with Gradle 7.0.
Use '--warning-mode all' to show the individual deprecation warnings.
See https://docs.gradle.org/6.3/userguide/command_line_interface.html#sec:command_line_warnings
    Kefas21
    @Kefas21

    Hello, I have a problem with Orchid build/run
    Gradle version: 3.5

    Flag values:

    -NETLIFY: false
    -PULL_REQUEST: false
    -adminTheme: Default
    -baseUrl: true
    -defaultTemplateExtension: peb
    -dest: C:\Users\username\Documents\MES\build\docs\orchid
    -diagnose: false
    -dryDeploy: false
    -environment: debug
    -experimentalSourceDoc: false
    -legacyFileServer: false
    -legacySourceDoc: false
    -logLevel: VERBOSE
    -port: 8080
    -src: C:\Users\username\Documents\MES\src\orchid\resources
    -task: build
    -theme: Default
    -version: 1.5.1

    [INFO] Orchid: Running Orchid version 0.21.1, site version 1.5.1 in debug environment
    java.lang.NullPointerException
    at com.eden.orchid.api.options.OptionsHolder.extractOptions(OptionsHolder.java:12)
    at com.eden.orchid.api.OrchidContextImpl.lambda$extractServiceOptions$1(OrchidContextImpl.java:124)
    at java.util.HashMap$Values.forEach(HashMap.java:981)
    at com.eden.orchid.api.OrchidContextImpl.extractServiceOptions(OrchidContextImpl.java:123)
    at com.eden.orchid.api.tasks.TaskServiceImpl.initOptions(TaskServiceImpl.java:65)
    at com.eden.orchid.api.tasks.TaskServiceImpl.build(TaskServiceImpl.java:121)
    at com.eden.orchid.api.tasks.TaskService.build(TaskService.java:26)
    at com.eden.orchid.impl.tasks.BuildTask.run(BuildTask.kt:12)
    at com.eden.orchid.api.tasks.TaskServiceImpl.runTask(TaskServiceImpl.java:79)
    at com.eden.orchid.api.tasks.TaskServiceImpl.onPostStart(TaskServiceImpl.java:70)
    at java.util.HashMap$Values.forEach(HashMap.java:981)
    at com.eden.orchid.api.OrchidContextImpl.start(OrchidContextImpl.java:100)
    at com.eden.orchid.Orchid.start(Orchid.java:96)
    at com.eden.orchid.Orchid.start(Orchid.java:62)
    at com.eden.orchid.Orchid.internalMain(Orchid.java:54)
    at com.eden.orchid.Orchid.main(Orchid.java:45)
    [ERROR] Errors:
    [ERROR] Orchid:
    [ERROR] - Something went wrong running Orchid

    Thanks in advance for any help!

    Alfhir
    @Alfhir
    Hi, I can´t get the Netlify-CMS integration to work, not even with the starter-project.? Is there more docs somewhere, or maybe another project with CMS integrated?
    Adrian Wyssmann
    @papanito
    What is the status of the project? Latest changes in the repo are 8 months ago... Thanks
    loke
    @loke:dhsdevelopments.com
    [m]
    @papanito: It does seem to have been abandoned. I posted this bug report a week ago with no response: orchidhq/Orchid#394
    It's really quite sad, since I settled on Orchid for my project (which is Kotlin-based) once I found it. It was precisely what I needed, being easily integrateable with Gradle and also supporting asciidoc, which is what I use for all markup.
    Sean M
    @stmty9
    it is open source, so no reason why more people can contribute (unless PRs and such are also being ignored)
    loke
    @loke:dhsdevelopments.com
    [m]
    @stmty9: given the fact that there have been zero interaction on any bug reports, not even on the issue of jcenter decommissioning (which will stop any builds in a couple of months), I'm not holding out hope that any PR's will be accepted.
    Someone would have to do a full fork of the project.
    It's really odd that the entire development seemed to have completely stopped shortly after the last release. No commits, no comments on bug reports, no website updates, absolutely nothing.
    I was looking at cjbrooks commit history, and he's almost completely stopped committing after july last year, and the few commits he has done has been on private repositories. This looks just like someone who has started a new job and has therefore changed priorities.