Windows Support
See original GitHub issueprocess.env.PWD
is undefned
on Windows systems.
It’s usually encouraged to use process.env.cmd
instead but I’m not sure what the implications are on this specific project.
Issue Analytics
- State:
- Created 6 years ago
- Comments:10
Top Results From Across the Web
Microsoft Support
Microsoft support is here to help you with Microsoft products. Find how-to articles, videos, and training for Microsoft 365, Windows, Surface, and more....
Read more >Contact - Microsoft Support
Contact Microsoft Support. Find solutions to common problems, or get help from a support agent.
Read more >End of support for Windows 7 and Windows 8.1 - Microsoft
After January 10, 2023, Microsoft will no longer provide security updates or technical support for Windows 8.1. You might be able to upgrade...
Read more >Microsoft Community
Welcome to the Microsoft Support Community. Need help? We've got answers! Search, browse, or ask a question. Choose where you want to search...
Read more >Windows 10 Home and Pro - Microsoft Lifecycle
Go here to learn more. Microsoft will continue to support at least one Windows 10 release until October 14, 2025. Support dates are...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Thanks everyone for your support - using the fork of @romaric-juniet I was able to get it running. I will leave this open for other users as a guide until it is fixed on the main version.
Steps to take to make it run on Windows
where doxity
npm uninstall -g doxity
supposedly does the same but didn’t remove it for me)solc
command inside the script)npm install -g romaric-juniet/doxity
to install the fork as global doxity. You should see the doxity files reappear in the folder.doxity init
which now works (original can’t even init)doxity build --src "contracts\Contract.sol"
, as neither wildcards, nor absolute paths worked.docs
folder. Deploy that folder on your webhost.Optional Opening the HTML files in your browser won’t work, as the
docs
folder creates some files only once. Usenpm install -g http-server
to install a webserver. Navigate to thedocs
folder with the javascript files on the same level and runhttp-server
- now you can navigate and have all pages render correctly.I have cloned Doxity in my windows platform, and done some changes to make it run. I’m still new to contributing to public gitHub projects like this. What would be the best way for me to share this work with the community?
At the moment, I am able to produce documentation successfully on Windows. The changes I made fall in these categories:
There are 2 more changes that are necessary to make the tool run, but which I don’t personally like:
I changed my package.json to make the “compile” target work in Windows. I don’t know how to make it work both for windows and *nix simultaneously, so this is a very targeted change. I welcome suggestions on how to make it more general.
In order to get around the process.env.pwd, I used a maybe hacky solution: I created a new doxity.cmd that I invoke locally and which sets an environment variable called PWD. I have seen people using cwd(). When I started adapting Doxity, I looked it up to see what cwd() does and I found this post: https://stackoverflow.com/questions/31414852/process-env-pwd-vs-process-cwd which put me off using cwd(). Any comments welcome.