Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Activity
    Jeremy Wright
    @jmwright_gitlab
    I tried it on a Pop OS 20.10 machine (based on Ubuntu 20.10 with Python 3.8.6 and GitBuilding seems to work fine. I'll use Anaconda to force a newer version of Python on Ubuntu 18.04 to try to determine if there is an incompatibility with Python 3.6.x.
    Julian Stirling
    @julianstirling_gitlab
    If that is the case I can add a python 3.6 check to the CI and then push out a patch. We say 3.6 or greater but we only test 3.7
    3.6 is required because my early implementation used f strings so heavily that I had no intention of going back and fixing it!!
    Jeremy Wright
    @jmwright_gitlab
    Ok, I just confirmed it. I created 3 environments with Miniconda, from Python 3.6 up thru Python 3.8. 3.8 worked with no errors or warnings. 3.7 gave a few dependency errors when I installed gitbuilding but worked fine. 3.6 threw the buildup error.
    Jeremy Wright
    @jmwright_gitlab
    Has there been talk about adding a filesystem watcher so that gitbuilding serve will work with external editors (VS Code, emacs, etc)? Is there support for a feature request related to that? Also, is it intended that when I click the Edit button with the landing page selected, that both panes seem to fill with the content for a new page, rather than editing the landing page itself?
    Jeremy Wright
    @jmwright_gitlab
    Looks like the edit button link for the landing page should point to http://localhost:6178/landing.html/-/editor/ instead of http://localhost:6178/index.html/-/editor/. I'm assuming the exported html in _site turns landing.md into index.html though to avoid additional web server configuration though.
    Jeremy Wright
    @jmwright_gitlab
    This should be my last one for this evening. I changed the hardware license in buildconf.yaml to match what I have on my repository, and now I get a warning: Warning: License CERN-OHL-P set configuration. Could not match to licence text. I'm not sure what GitBuilding is matching against, but CERN-OHL-P should be a valid license code. I also just noticed that "license" is misspelled. I'm still learning GitBuilding, but I like where you're headed with it. I may want to retract my question about using external editors. BuildUp is just enough different that it creates a fair amount of friction with the markdown extension I use. Some syntax highlighting in GitBuilding's markdown editor would be very welcome though.
    Julian Stirling
    @julianstirling_gitlab
    These are all really useful feedback. The landing page thing seems to be a bug. The file system watcher is something that would be good to do. Syntax highlighting I tried to do, but I suck at javascript and everything I tried broke something else. As for licenses we use the SPDX list: https://github.com/spdx/license-list-data/tree/master/text
    Jeremy Wright
    @jmwright_gitlab
    Thanks, I had not put -2.0 on the end of the CERN-OHL-P license identifier. That's fixed now. The editing bug only happens when at the root of the server (http://localhost:6178/). If you're at this address http://localhost:6178/landing.html clicking Edit has the intended behavior. A flash message instead of a popup after clicking Save (or at least when hitting Ctrl+S) would be helpful during busy editing sessions. Having to acknowledge the popup after saving adds some friction for somebody like me who compulsively saves.
    Jeremy Wright
    @jmwright_gitlab
    I feel like it would be good if links to external sites opened in a new tab by default. Right now what I have is a link to the CadHub.xyz website where the user can modify, run and download a 3D model created in CadQuery. When I click on that, CadHub loads in the GitBuilding tab and the user loses their place in the docs. Normally I would embed html with target=_blankto achieve this, but I'm not sure how that would work in GitBuilding's editor, and it seems a little clunky to mix HTML into markdown anyway. Thoughts?
    Julian Stirling
    @julianstirling_gitlab
    could configure it in the configuration files on whether you want weblinks to be in a new tab?
    Jeremy Wright
    @jmwright_gitlab
    Sure, that would be great.
    GitBuilding doesn't already do that, does it?
    Jeremy Wright
    @jmwright_gitlab
    Doesn't look like it based on the docs.
    Jeremy Wright
    @jmwright_gitlab
    Is there an accepted way to mark a step as optional? Put "(Optional)" in the title, "Optional" in the Note, or both? Something else maybe?
    Julian Stirling
    @julianstirling_gitlab
    Hmm not for an optional step. You can add notes to parts..
    Jeremy Wright
    @jmwright_gitlab
    Screenshot from 2021-06-09 16-38-50.png
    It might be nice if a note on a part had some sort of indicator attached to it. Right now the part name and the note kind of run together. Maybe that's intended though?
    Or maybe notes could be in a tooltip or in a text area that can be expanded/collapsed? I don't know, just throwing ideas out there.
    Sorry, the previous screenshot of the rendered text was from the wrong spot.
    Screenshot from 2021-06-09 16-46-26.png
    Jeremy Wright
    @jmwright_gitlab
    Right now what I'm doing is prefixing the Note with something like " - " to give it some separation.
    Julian Stirling
    @julianstirling_gitlab
    yes. In master the " - " should ba added automatically as I found I was doing the exact same thing
    Jeremy Wright
    @jmwright_gitlab
    Image galleries are supported which I think is really great, but I don't see anything about image captions in the docs. Are captions available?
    Julian Stirling
    @julianstirling_gitlab
    No, but probably should be. Would you be happy opening some of these suggestiosn as GitLab issues so I don't forget them?
    Jeremy Wright
    @jmwright_gitlab
    Sure. I didn't want to flood your issue tracker with noob questions at the beginning, but I've got a simple project documented in GitBuilding now, and I'll go back through and pick out some of the things I brought up here on Gitter.
    Julian Stirling
    @julianstirling_gitlab
    Fantastic, thanks so much. Really interesting to see how someone new experiences the project
    Jeremy Wright
    @jmwright_gitlab
    Sorry, please ignore that last message. I wasn't paying enough attention and it's published my readme. The workflow that's generated by GitBuilding is running without an error, but the page isn't showing up.
    Ok, I got it. Please let me know if there are things I need to improve about my use of GitBuilding's tools. https://7b-things.github.io/braille-signage-generator/
    Julian Stirling
    @julianstirling_gitlab
    Looks good. I had planned to go through some f your points with Kaspar on tuesday at our bi-weekly code session. We got distracted with non-GitBuilding things. Hopefully we will get a chance next time.
    Jeremy Wright
    @jmwright_gitlab
    When I export my build docs to HTML, the tab title in the browser, title at the top of the page, and title in the nav bar on the left all say "Untitled Project". I didn't have that problem before I exported. I do have the Title value set in buildconf.yaml, so I'm not sure why this is happening.
    Screenshot from 2021-06-18 13-41-43.png
    Jeremy Wright
    @jmwright_gitlab
    Ok, please don't spend any time researching my question above. It was complete user error. I ran the build from the parent directory, which sort of worked but broke things like the page titles.
    Jeremy Wright
    @jmwright_gitlab
    I have deployed a GitBuilding project to the static directory of a larger site, so it's not hosted as the root site. That makes it so that I have to end the home/root URL with index.html instead of just a forward slash. When GitBuilding generates the static HTML, it assumes that the root of the docs will be available via the forward slash URL, so the home links in the title and top of the nav bar are effectively broken (with the way I have it deployed). Right now I'm editing each of the pages by hand to fix this. It would be nice to have an setting to make the home/root links use index.html instead of assuming forward slash. Does this make sense?
    Julian Stirling
    @julianstirling_gitlab
    Yeah. I need to look into that, I thought I fixed buy making all links relative. This is v0.8?
    Jeremy Wright
    @jmwright_gitlab
    v0.8.4. The link is relative, but it's "./" instead of "./index.html", which in my case breaks the links.
    If you remove the index.html from this URL, you will recreate the URL that the nav/title links lead to. https://7bindustries.com/static/braille-signage-generator/index.html
    Jeremy Wright
    @jmwright_gitlab
    I know I'm just always asking for more features or fixes, but I do really like GitBuilding. Thanks for the great tool!
    Jeremy Wright
    @jmwright_gitlab
    So the more I think about the "./" vs "./index.html" problem, the more I'm glad I didn't file an issue for it. I think it's probably mostly due to the fact that I'm serving the files from the static directory of a Flask app, which is behind an nginx server. If I was just serving it via nginx, I don't think this would be an issue. All I should need to do is to add a route in the Flask app that serves the index.html file at the URL that GitBuilding expects. I'll hopefully have time to try that tomorrow.
    Jeremy Wright
    @jmwright_gitlab
    I've deployed a fix for this in my Flask app. Sorry for the noise.
    Julian Stirling
    @julianstirling_gitlab
    Not at all. It is just so nice to see people using it
    Soon I hope to make a start on some of the issues you found
    Julian Stirling
    @julianstirling_gitlab
    V0.9 is released, It fixes the bug with the landing page and also adds the space around the note as well as a number of other things that have been in the pipeline for a while https://pypi.org/project/gitbuilding/0.9.0/
    Jeremy Wright
    @jmwright_gitlab
    Great, thanks!
    Andrew Zicler
    @douile17

    I found the problem in your documentation for the 3d view in a local site, i have to creat a -no-server build, but when i try i have this message : usage: gitbuilding [-h] [--version] <command> ...
    gitbuilding: error: unrecognized arguments: -no-server.

    do you have an idea ?

    Jeremy Wright
    @jmwright_gitlab
    The following works for me in both gitbuilding 0.8.4 and 0.9.0. gitbuilding build-html --no-server
    kinu
    @kinu:matrix.org
    [m]

    Hi all! I have a question: is there a syntax highlighting functionality for code chunks in markdown? those sandwiched between three backticks ยดยดยด (i think its called "fenced code").

    I looked at the markdown module used to render the .md files to HTML: https://python-markdown.github.io/reference/

    It seems to have a syntax highlighting extension available, but im not sure how to use it.

    The render_md function at gitbuilding/render.py seems to load extensions such as this one.

    Using the extension also requires generating a CSS stylesheet for the highlighting using python-pygments.

    There may be more requirements, but that is as far as i got for now.

    Perhaps one of you will know how to enable this feature. Im interested because i got used to syntax highlighting and it sort of became important (at least to me) when looking at code.

    Thanks :)

    kinu
    @kinu:matrix.org
    [m]
    PS: i opened an issue here gitbuilding/gitbuilding#225
    Julian Stirling
    @julianstirling_gitlab
    I have answered in the issue thread
    I think the highlighting needs to be solved in Javascript. But I am not the best person to do that. GitBuilding really needs a Javascript developer. Rather than me hacking wildly whenever we need to improve the editor