so probably this was a leftover from before we moved from out to _out, you should just remove that folder.
Installing ourbigbook locally is generally the best option, because this way you have a specific version for it on your package.json that you know conversion will work at. See e.g. the template repository for an example: github.com/ourbigbook/template But global install with -g should work too.
About the title of the first header of index.bigb, you can call it whatever you want. It will always have a magic empty ID + a synonym for the title e.g. pioyi-s-index. The title will only show up on static renders like github.com/ourbigbook/template, on ourbigbook.com you see "Home" and your username instead: ourbigbook.com/cirosantilli
Could you double check that the sample code is displaying correctly? Backslash in \= should escape the = and not create a header, so I'm assuming it is a formatting error? Or do you actually have backslash in your source code?
You can just dump basically any code directly inside backticks for your sample, you don't need to escape special characters there unless the code contains backticks itself
to get these local conversion updates and a few others I've added recently.
Thanks a lot once again for this report! Local to web upload is hard to get right, and I've had many issues myself, but I try to fix this with high priority, and new users stress it in different ways which is great.
A tip, during web upload, ourbigbook first splits the headers to separate files under out/web, so looking there can help understand what went wrong. But not something I want users to ever have to worry about of course, the goal is that if it converts locally without error, it should upload without error.
Your files have to be really huge before being in a single file starts becoming a problem, so don't worry too much about it.
Previously cirosantilli.com was one humongous README.adoc, but it reached a point where the HTML was too slow to load lol.
That was part of the motivation of ourbigbook. But when you reach that point, ourbigbook makes the transition to multifile will be as seamless as it can be.
BTW you might want to use the {parent= syntax rather than header levels.
= My h1
= My h2
{parent=My h1}
= My h3
{parent=My h2}
This allows you to move chunks around very easily (within the same file, or to other files), without having to change a billion header levels each time.
Hmm can you give a bit more of the error logs and perhaps local source? Also double check that every file is reachable from the README.bigb via \\Include (I'm going to add a local check for this soon).
OK, I understood the problem now by inspecting the server DB. The root problem is that you uploaded something like (by accident or due to another ourbigbook bug):
= asdf $$
$$ qwer
which the server incorrectly accepted, such syntax should not be allowed.
When, the web_delete things is what happens when you delete an ID locally, but the server still contains it, so it deletes it from the server, which means: 1) mark as unlisted 2) make the body empty (remove all sub-ids like images) thus leaving you with:
= asdf $$
which is an unclosed string literal thus the error message.
I've now tried to clean that up from the DB, and I'll make sure that the offending syntax is forbidden both locally and on server (I've been adding several such checks in recent patches and I'll add this in as well, I was not aware of it).
Can you try ourbigbook --web again and see if it got fixed?
Some logs for my own reference:
path
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
@pioyi/claus-processcreated-by-the-german-chemist-carl-friedrich-claus-it-makes-it-possible-to-convert-hydrogen-sulfide-from-natural-gas-to-elemental-sulfur-the-overall-reaction-can-be-descibed-as-follows-2-h-2s-plus-so-2-3s-plus-2h-20.bigb
(1 row)
ourbigbook::DATABASE=> select "titleSource" from "File" where "path" LIKE '@pioyi/claus-processcreated-by-the-german-chemist-carl-friedrich-claus-it-makes-it-possible-to-convert-hydrogen-sulfide-from-natural-gas-to-elemental%';
titleSource
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Claus processCreated by the german chemist Carl Friedrich Claus, it makes it possible to convert hydrogen sulfide (from natural gas) to elemental sulfur.The overall reaction can be descibed as follows: $$
(1 row)
ourbigbook::DATABASE=> select "bodySource" from "File" where "path" LIKE '@pioyi/claus-processcreated-by-the-german-chemist-carl-friedrich-claus-it-makes-it-possible-to-convert-hydrogen-sulfide-from-natural-gas-to-elemental%';
bodySource
-----------------------------------------------------------------------------------------------------------------------------------------------------
2 H_2S + SO_2 -> 3S + 2H_20. +
$$ +
+
The Claus' process served as a better replacement of the Frasch process, which obtained elemental sulfur from naturally found deposits underground.+
(1 row)
ourbigbook::DATABASE=>
And how I tried to fix it:
ourbigbook::DATABASE=> update "File" set "bodySource" = '' where "path" LIKE '@pioyi/claus-processcreated-by-the-german-chemist-carl-friedrich-claus-it-makes-it-possible-to-convert-hydrogen-sulfide-from-natural-gas-to-elemental%';
UPDATE 1
ourbigbook::DATABASE=> update "File" set "titleSource" = 'claus-processcreated-by-the-german-chemist-carl-friedrich-claus-it-makes-it-possible-to-convert-hydrogen-sulfide-from-natural-gas-to-elemental-sulfur-the-overall-reaction-can-be-descibed-as-follows-2-h-2s-plus-so-2-3s-plus-2h-20' where "path" LIKE '@pioyi/claus-processcreated-by-the-german-chemist-carl-friedrich-claus-it-makes-it-possible-to-convert-hydrogen-sulfide-from-natural-gas-to-elemental%';
UPDATE 1
ourbigbook::DATABASE=>
These are things that would be really cool to have as a more structured metadat like Wikipedia does via Wikidata, but I'm staying off the structured data for now, though tempted.
Awesome! Good reminder that I need to add comment editing as well 😂
And as usual, feel free to write about anything you want and at any quality level, including quick drafts or self notes. There is no moderation and nor algorithmic downside for crap content of any kind.
BTW I've added the following to docs.ourbigbook.com/ourbigbook-com-content-license I hope this is a reasonable clause given that I'm putting years of my life into this project. I understand it could put some people off, and I don't intend to ever relicense anything lightly, as it would be an instant reputational hit. This had been on the back of my mind for a while, but after seeing your contributions I've decided to do it now before more content gets added. It does not affect any of the pre-existing content.
Starting from August 22 2024, users also automatically grant to the OurBigBook Project a non-exclusive license to relicense their content. This could be used for example to:
sell the content to companies that do not wish to comply with the CC By-SA license, e.g. for LLM training. We will try to avoid ever doing this as much as possible since it goes against the vision of the project for open knowledge. But it could one day be the difference between life and death of the project, so we'd like to keep that door open just in case.
add a new license to content on the website which we feel might better serve all users
Any such relicensing does not affect the original CC BY-SA 4.0 license nor your ownership of the content. It only adds new licenses on top of it. This way the content remains free no matter what.
outto_out, you should just remove that folder.package.jsonthat you know conversion will work at. See e.g. the template repository for an example: github.com/ourbigbook/template But global install with-gshould work too.index.bigb, you can call it whatever you want. It will always have a magic empty ID + a synonym for the title e.g.pioyi-s-index. The title will only show up on static renders like github.com/ourbigbook/template, on ourbigbook.com you see "Home" and your username instead: ourbigbook.com/cirosantilliourbigbook --webfor upload or something else?_out. Just in case.\=should escape the=and not create a header, so I'm assuming it is a formatting error? Or do you actually have backslash in your source code?out/web, so looking there can help understand what went wrong. But not something I want users to ever have to worry about of course, the goal is that if it converts locally without error, it should upload without error.{parent=syntax rather than header levels.README.bigbvia\\Include(I'm going to add a local check for this soon).web_deletethings is what happens when you delete an ID locally, but the server still contains it, so it deletes it from the server, which means: 1) mark as unlisted 2) make the body empty (remove all sub-ids like images) thus leaving you with:ourbigbook --webagain and see if it got fixed?title2like: ourbigbook.com/cirosantilli/list-of-chemical-elements#helium with source: ourbigbook.com/go/source/cirosantilli/helium